Add contribution guidelines #428

bahiirwa · 2019-06-28T06:59:56Z

Change in docs to make guided contributions in PRs
Reference: ClassicPress/ClassicPress-v1#144

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

README.md

nylen

I like the direction this is going, but it is not ready for inclusion yet. The new content needs to be added to a new CONTRIBUTING.md document, which is the GitHub standard for contribution instructions.

The contributing document should also be structured as a start-to-finish guide to submitting an issue or a change to ClassicPress, including a note about the petitions process for major changes, and a note to submit an issue instead of a PR if someone isn't sure how their proposed change fits within the guidelines.

We can then link to this document from the readme and from the issue/PR templates.

Cleanup readme to make a contributions.md file

Add automated unit tests link

Initial commit for contributing.md

Add quick link to help notes in contributing.md

bahiirwa · 2019-06-29T09:10:27Z

I have made a PR refresh. Some parts of the original message in backporting WP changesets were vague to me. Please include any changes that are missing for the process to be better.

File name change and inclusion of a code of conduct. I realized we have something very limited on the CP website about conduct and this is only in the forums.

.github/CONTRIBUTING.md

README.md

Keep the code of conduct cutting across the platforms.

Change casing to the right CONTRIBUTING.md file

Mte90

Good job!
I was already following the pr but now is in a very good status, just few changes to improve it the readability for newcomers to the community.

.github/CONTRIBUTING.md

.github/PULL_REQUEST_TEMPLATE.md

Add some change requests

Fix Typo

Add slack invite for writing automated testing help

bahiirwa · 2019-07-31T12:33:58Z

Please review this PR and kindly let me know what needs to be pushed for it to be completed.

Specific action items, with brief explanation of how our process works along with the appropriate links.

Try to explain why (in what situations) a contributor would use each of these channels.

Explain the how and why of backporting changes from WordPress.

nylen · 2019-08-01T06:03:28Z

I've pushed some suggested updates, trying to make the document flow better with clearer explanations of each part. Please let me know what you think, and I'll also leave a few specific comments.

nylen · 2019-08-01T06:06:19Z

.github/CONTRIBUTING.md

+- [Slack](https://www.classicpress.net/join-slack/) - great for real-time chat, posting screenshots and asking questions about anything you're stuck on. Or just socializing.
+- [Petitions website](https://petitions.classicpress.net/) - for proposing new features or major changes for consideration by the community.
+- [GitHub issues](https://github.com/ClassicPress/ClassicPress/issues) - for proposing or discussing bugfixes, or minor improvements. Generally it is a good idea to create a petition for anything that may take a significant amount of time or that may have backwards compatibility implications.
+- [Forums](https://forums.classicpress.net/) - a lot of good info and discussion here too


Our forums are a great resource, I want to say something better than "a lot of good info and discussion here too". In what situations would someone want to make a forum thread rather than using one of the other communication channels?

nylen · 2019-08-01T06:08:12Z

.github/CONTRIBUTING.md

+
+If you're not sure where to start contributing, here are some ideas:
+
+  - Review and test [existing PRs](https://github.com/ClassicPress/ClassicPress/pulls), especially looking at how well they fit the criteria described above.


I don't think this sentence does a good job of stating how important reviewing and testing are. We need to be thorough and careful with the changes we make, and the more eyes we can get on our PRs the better.

.github/CONTRIBUTING.md

nylen · 2019-08-01T06:10:08Z

.github/ISSUE_TEMPLATE.md

@@ -9,6 +9,8 @@ https://petitions.classicpress.net/

 For more details about our governance and change planning process, see:
 https://www.classicpress.net/democracy/
+
+Please find guidelines on how to contribute to this project in our [CONTRIBUTING.md](../CONTRIBUTING.md)


I'd like to take this further. This should be a checkbox at the top of the issue template, and we should take a look at what can be removed from the template once that's added.

nylen · 2019-08-01T06:10:38Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,6 +9,8 @@ https://petitions.classicpress.net/

 For more details about our governance and change planning process, see:
 https://www.classicpress.net/democracy/
+
+Please find guidelines on how to contribute to this project in our [CONTRIBUTING.md](../CONTRIBUTING.md)


I'd like to take this further. This should be a checkbox at the top of the PR template, and we should take a look at what can be removed from the template once that's added.

nylen · 2019-08-01T06:10:57Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -25,7 +27,7 @@ If it fixes an open issue, please link to the issue here.

 ## How has this been tested?
 <!--
-Please describe in detail how you tested your changes.
+Please describe in detail how you tested your changes. If you have challenges writing tests, please consult the document linked. https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/ or reach the community on [slack](https://join.slack.com/t/classicpress/shared_invite/enQtNDIwNjY2OTg1MjAxLWJiM2U2NmY3ZjFlZjQ4Zjk2OGI4ZTg3NzY1ZTU3NzI3OTRjMTU0YzAzOWUyZmZlODgyOWE1YTViYjcwY2Y5YzI)


Let's use https://www.classicpress.net/join-slack/ instead. It redirects to the long invite link, but it's shorter and we can update the invite link later if needed.

Also I wonder if this should go in the main contributing document instead?

good idea, better add there the petitions link instead (people start pr without check it)

Petitions link doesn't make sense under "How has this been tested". Better to point people to the contribution documentation which explains how the petitions work.

Marking as unresolved, this link still needs an update.

nylen · 2019-08-01T06:11:45Z

README.md


-We are working on several ways to recognize people for their contributions to ClassicPress.  In the meantime, you can view a list of code contributions [here on GitHub](https://github.com/ClassicPress/ClassicPress/compare/LAST_WP_COMMIT...develop).
+Would you like to help? [Here is how you can start](../documentation/.github/CONTRIBUTING.md).


Let's switch these two paragraphs ("Would you like to help" before "We are working on...").

nylen

I think this is good to go now, I've cleaned up a few more things and also added a section about automated tests. I'm going to go ahead and merge it, because I'd like to link to this from a blog post, but please feel free to leave comments about things that can still be improved further here.

Update docs on bugs and changesets

bcf1e82

bahiirwa mentioned this pull request Jun 28, 2019

Improving the docs for contributions. ClassicPress/ClassicPress-v1#144

Closed

Mte90 approved these changes Jun 28, 2019

View reviewed changes

nylen reviewed Jun 28, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

nylen reviewed Jun 28, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

nylen reviewed Jun 28, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

nylen suggested changes Jun 28, 2019

View reviewed changes

bahiirwa added 6 commits June 29, 2019 11:18

Clean up Readme.md

787848f

Cleanup readme to make a contributions.md file

Update PULL_REQUEST_TEMPLATE.md

4485bc2

Add automated unit tests link

Create contributing.md

9f6b842

Initial commit for contributing.md

Update README.md

37ae428

Add quick link to help notes in contributing.md

Update contributing.md

6978c5a

Update contributing.md

aa75eb4

Update and rename contributing.md to CONTRIBUTING.md

d73f715

File name change and inclusion of a code of conduct. I realized we have something very limited on the CP website about conduct and this is only in the forums.

nylen reviewed Jun 29, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

nylen reviewed Jun 29, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

bahiirwa added 3 commits July 3, 2019 09:59

Add proper Code of conduct from Website

402bcd6

Keep the code of conduct cutting across the platforms.

Proper linking

107ede6

Change casing to the right CONTRIBUTING.md file

Hierarchy improvements for visual

0f272ba

Mte90 suggested changes Jul 4, 2019

View reviewed changes

This was referenced Jul 4, 2019

Integrate patch from 5.0 ClassicPress/ClassicPress-v1#153

Closed

Integrate WordPress changes from 5.1 ClassicPress/ClassicPress-v1#152

Closed

bahiirwa added 7 commits July 15, 2019 20:42

Update CONTRIBUTING.md

c8f8027

Add some change requests

Fix Typo

c83f299

Fix Typo

Update CONTRIBUTING.md

7d209c6

Update PULL_REQUEST_TEMPLATE.md

3ffad2b

Add slack invite for writing automated testing help

Merge branch 'develop' into documentation

1224e65

Update ISSUE_TEMPLATE.md

0621ae8

Update PULL_REQUEST_TEMPLATE.md

c246a3a

bahiirwa added 2 commits July 31, 2019 15:28

Add details on wpdirectory

6072aa5

Update CONTRIBUTING.md

13cc94f

nylen added 5 commits August 1, 2019 01:01

Update introductory section

234b86c

Specific action items, with brief explanation of how our process works along with the appropriate links.

Update communication channels

a92ff56

Try to explain why (in what situations) a contributor would use each of these channels.

Update review criteria

02534f1

Ideas for what to work on

39e7fca

Update backporting section

36ccd7e

Explain the how and why of backporting changes from WordPress.

nylen changed the title ~~Update docs on bugs and changesets~~ Add contribution guidelines Aug 1, 2019

Add main header

b3cc714

nylen reviewed Aug 1, 2019

View reviewed changes

.github/CONTRIBUTING.md Show resolved Hide resolved

nylen reviewed Aug 1, 2019

View reviewed changes

nylen added 7 commits August 1, 2019 01:13

A bit shorter

1b5390d

Readme cleanup

dd1a73b

Improve wording about the forums

001b9fe

Update wording about reviews/testing

f00459c

Add section about automated tests

9599e39

Clean up issue/PR templates

2b00439

Minor tweaks

341d941

nylen approved these changes Aug 11, 2019

View reviewed changes

nylen merged commit dc739de into ClassicPress:develop Aug 11, 2019

bahiirwa deleted the documentation branch September 14, 2019 12:34

viktorix added the exclude For filtering purposes only. label Jan 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add contribution guidelines #428

Add contribution guidelines #428

bahiirwa commented Jun 28, 2019

nylen left a comment

bahiirwa commented Jun 29, 2019

Mte90 left a comment

bahiirwa commented Jul 31, 2019

nylen commented Aug 1, 2019

nylen Aug 1, 2019

nylen Aug 1, 2019

nylen Aug 1, 2019

nylen Aug 1, 2019

nylen Aug 1, 2019 •

edited

nylen Aug 1, 2019

Mte90 Aug 1, 2019

nylen Aug 1, 2019

bahiirwa Aug 1, 2019

nylen Aug 2, 2019

nylen Aug 1, 2019

nylen left a comment


		If you're not sure where to start contributing, here are some ideas:

		- Review and test [existing PRs](https://github.com/ClassicPress/ClassicPress/pulls), especially looking at how well they fit the criteria described above.


		We are working on several ways to recognize people for their contributions to ClassicPress. In the meantime, you can view a list of code contributions [here on GitHub](https://github.com/ClassicPress/ClassicPress/compare/LAST_WP_COMMIT...develop).
		Would you like to help? [Here is how you can start](../documentation/.github/CONTRIBUTING.md).

Add contribution guidelines #428

Add contribution guidelines #428

Conversation

bahiirwa commented Jun 28, 2019

Checklist:

nylen left a comment

Choose a reason for hiding this comment

bahiirwa commented Jun 29, 2019

Mte90 left a comment

Choose a reason for hiding this comment

bahiirwa commented Jul 31, 2019

nylen commented Aug 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nylen Aug 1, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nylen left a comment

Choose a reason for hiding this comment

nylen Aug 1, 2019 •

edited