Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit Contributing docs #1278

Closed
6 tasks done
stevepiercy opened this issue Aug 19, 2022 · 3 comments
Closed
6 tasks done

Edit Contributing docs #1278

stevepiercy opened this issue Aug 19, 2022 · 3 comments
Assignees
Milestone

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Aug 19, 2022

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.

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

@stevepiercy
Copy link
Contributor Author

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
Copy link
Member

fredvd commented Mar 27, 2023

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)

fredvd added a commit that referenced this issue Apr 1, 2023
…ocs that come from buildout.coredev

Move documentation to subfolder, link from main index.
Refs #1278
@stevepiercy stevepiercy moved this from Todo to In Progress in Install Docs Apr 2, 2023
@stevepiercy stevepiercy moved this from Todo to In Progress in Release Plone 6 docs Apr 2, 2023
stevepiercy added a commit to plone/volto that referenced this issue Apr 2, 2023
…re code contributing requirements

Refs: plone/documentation#1478 and plone/documentation#1278

Do not merge until the documentation PR is merged, as this PR depends on the resolution of intersphinx references.
@stevepiercy stevepiercy changed the title Create a Contributing to Plone Core Code section Create a Contributing to Plone section Apr 7, 2023
@plone plone deleted a comment from JatinPandey26 Apr 9, 2023
@stevepiercy stevepiercy moved this to Todo in Plone 6.1 Apr 13, 2023
@stevepiercy
Copy link
Contributor Author

Closing as completed. There's a couple of open PRs that will close this anyway.

@github-project-automation github-project-automation bot moved this from In Progress to Done in Install Docs Jul 20, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Plone 6.1 Jul 20, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Release Plone 6 docs Jul 20, 2024
@stevepiercy stevepiercy unpinned this issue Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Status: Done
Status: Done
Development

No branches or pull requests

3 participants