Create a Contributing to Plone section

[stevepiercy]

Description

We frequently get newbie requests to contribute. Plone 6 docs lack one way to do things, but we have numerous packages and documentation that each have their own way to contribute.

• Contributing to Documentation - Consider the following:
  • Create a new primary navigation item "Contributing".
  • Move this content deeper under "Contributing" and rename it to "Documentation".
  • Create a new section under "Contributing" called "Contributing to Plone".
• Developing for Plone Core with its source at https://github.com/plone/buildout.coredev/tree/6.0/docs. See buildout.coredev docs need to be pulled into Plone 6 Documentation buildout.coredev#840
• Contributing to plone.api
• Contributing to plone.restapi
• Volto

There should be a generalized authoritative contributing document in plone/documentation, one that includes the items that every repo should follow. I would suggest the following:

• Include signing the Plone Contributor Agreement as the first step.
• General steps to propose a change (file an issue or post to the Community Forum, clone, branch, edit, run tests, commit, push, submit PR, request review from core contributors)
• Mention CI/CD requirements (GitHub Workflows, Jenkins)
• Mention that each project has its own details for contributing, and should be reviewed next, with a list of links to the core packages' contributing docs.

To Dos

• Create Plone Core Code contributing documentation #1478
• Update Volto contributing to align with and refer to the new Plone co… volto#4634
• Revise Contributing to plone.api
• Revise Contributing to plone.restapi
• Migrate and revise content from coredev. Refs: buildout.coredev docs need to be pulled into Plone 6 Documentation buildout.coredev#840
• Review branch https://github.com/plone/documentation/tree/contributing to determine what should and should not get migrated. There is a lot of irrelevant and outdated stuff

[stevepiercy]

I just got this from the Read The Docs newsletter. Here is a brilliant and well-organized guide, Contributing to Wagtail, a Django-based CMS. Very relevant to what we want to do.

[fredvd]

Here's another very good Idea I got from a talk held 2 weeks ago at FOSS-backstage 2023. A jenkins maintainer gave a talk with a lot of do's/works/didnt'work from a creating and maintaining a public road map. I really like this overview:

https://www.jenkins.io/participate/

(presentation here: https://www.youtube.com/watch?v=yVO2-uZbeQU)