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

Add contribution guidelines #428

Merged
merged 33 commits into from Aug 11, 2019
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
bcf1e82
Update docs on bugs and changesets
bahiirwa Jun 28, 2019
787848f
Clean up Readme.md
bahiirwa Jun 29, 2019
4485bc2
Update PULL_REQUEST_TEMPLATE.md
bahiirwa Jun 29, 2019
9f6b842
Create contributing.md
bahiirwa Jun 29, 2019
37ae428
Update README.md
bahiirwa Jun 29, 2019
6978c5a
Update contributing.md
bahiirwa Jun 29, 2019
aa75eb4
Update contributing.md
bahiirwa Jun 29, 2019
d73f715
Update and rename contributing.md to CONTRIBUTING.md
bahiirwa Jun 29, 2019
402bcd6
Add proper Code of conduct from Website
bahiirwa Jul 3, 2019
107ede6
Proper linking
bahiirwa Jul 3, 2019
0f272ba
Hierarchy improvements for visual
bahiirwa Jul 3, 2019
c8f8027
Update CONTRIBUTING.md
bahiirwa Jul 15, 2019
c83f299
Fix Typo
bahiirwa Jul 15, 2019
7d209c6
Update CONTRIBUTING.md
bahiirwa Jul 15, 2019
3ffad2b
Update PULL_REQUEST_TEMPLATE.md
bahiirwa Jul 15, 2019
1224e65
Merge branch 'develop' into documentation
bahiirwa Jul 31, 2019
0621ae8
Update ISSUE_TEMPLATE.md
bahiirwa Jul 31, 2019
c246a3a
Update PULL_REQUEST_TEMPLATE.md
bahiirwa Jul 31, 2019
6072aa5
Add details on wpdirectory
bahiirwa Jul 31, 2019
13cc94f
Update CONTRIBUTING.md
bahiirwa Jul 31, 2019
234b86c
Update introductory section
nylen Aug 1, 2019
a92ff56
Update communication channels
nylen Aug 1, 2019
02534f1
Update review criteria
nylen Aug 1, 2019
39e7fca
Ideas for what to work on
nylen Aug 1, 2019
36ccd7e
Update backporting section
nylen Aug 1, 2019
b3cc714
Add main header
nylen Aug 1, 2019
1b5390d
A bit shorter
nylen Aug 1, 2019
dd1a73b
Readme cleanup
nylen Aug 11, 2019
001b9fe
Improve wording about the forums
nylen Aug 11, 2019
f00459c
Update wording about reviews/testing
nylen Aug 11, 2019
9599e39
Add section about automated tests
nylen Aug 11, 2019
2b00439
Clean up issue/PR templates
nylen Aug 11, 2019
341d941
Minor tweaks
nylen Aug 11, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,37 @@
# Our [Code of Conduct](https://www.classicpress.net/democracy/#democracy-conduct) and [exceptions](https://www.classicpress.net/democracy/#democracy-exceptions)
Our code of conduct is simple: Be good to one another, take criticism well and follow the democratic process. When contributing to this repository, please note we have a [code of conduct](https://www.classicpress.net/democracy/#democracy-conduct) with some [exceptions](https://www.classicpress.net/democracy/#democracy-exceptions).
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

Our request is that you follow these guidelines in all your interactions with the project.

# Start helping
You can start helping by submitting pull requests(PRs) to the develop branch. This is not limited to:
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

## Documentation
Good documentation will make the work of making ClassicPress a better software much faster and a better user experience.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

## Fixing Bugs
Most of the bugs are shared via the [issues page](https://github.com/ClassicPress/ClassicPress/issues). When evaluating bug fixes pull requests(PRs), we look for, if not all these things

- The change impacts existing ClassicPress users. (Otherwise, there are literally thousands of things we could look at, but we need to prioritize our development time.)
- The change is not going to break any other use cases.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved
- The change has automated tests.
nylen marked this conversation as resolved.
Show resolved Hide resolved
- We understand the change very well or can ask questions of someone who understands it very well.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

## New Feature Requests
We have a number of [feature requests or petitions from our petitions website](https://petitions.classicpress.net/) submitted by different users and upvoted. It is desirable to start with the [planned](https://petitions.classicpress.net/?view=planned) or the [most wanted](https://petitions.classicpress.net/?view=most-wanted) or even submit PRs with your own suggested changes.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

## Backporting Changesets from WordPress
ClassicPress version 1.0.0 is a fork of WordPress 4.9.x however, since WordPress 5.0 a number of changes have been made to the core not limited to performance, bug fixes or new features. ClassicPress is commited to keeping compatibility of WordPress of WordPress 4.9. We however need help choosing, testing and documenting changesets to commit to the core with the backwards compatibility in mind.

The focus of ClassicPress is to be business oriented and avoid Gutenberg so one of the first check is to avoid changeset that cover Gutenberg or the Editor component. Below are some guidelines:
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

1. ***Evaluate the changeset***
First, check https://wpdirectory.net/ to evaluate how many plugins/themes are affected by this changeset.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

1. ***Pick the branch***
Selecting the right branch is important since 4.9.x is not developed actively except for security issues. ~~The other options is to check the 5.x branches but it is not a pre-requisite to do a check about the code if it exists in ClassicPress. The backport script will create a branch with the changeset. A test will be done about change to check if it is supported. Some times manual changes are required.~~
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

1. ***Documenting***
Properly written supporting documentation for the changeset is important. This will guide the mainatainers to evaluate the tests, consider the challenges the changeset seeks to solve or if the problem exists in ClassicPress posing a problem to the users.
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

***Note:*** ClassicPress seeks to improve the exisiting code quality, the documentation and tests. This might result in some delays in merging a pull request for merging.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -25,7 +25,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/
bahiirwa marked this conversation as resolved.
Show resolved Hide resolved

Include details of your testing environment, and the tests you ran to see how
your change affects other areas of the code, etc.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -6,7 +6,7 @@

ClassicPress is a hard fork of WordPress that serves the CMS-based business website market. We empower the people who create and support these websites, including plugin and theme developers.

We welcome contributions of all kinds! Have a look at
We welcome contributions of all kinds! Have a look at
[this repository's open issues](https://github.com/ClassicPress/ClassicPress/issues)
and
[our v1 project board](https://github.com/orgs/ClassicPress/projects/1),
Expand All @@ -23,10 +23,10 @@ For more information, see:

This project exists thanks to all the people who contribute and who have contributed in the past, whether as part of the long history of thousands of contributions to WordPress from many different people, or as contributions to ClassicPress itself.

You can see a list of WordPress contributors by going to the [WordPress releases page](https://wordpress.org/news/category/releases/) and looking at the credits for each release. All changes in WordPress 4.9.8 and earlier are part of ClassicPress, along with selected changes from later releases.
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).

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## Donate to support ClassicPress

Support the ClassicPress project by making a [[donation](https://donate.classicpress.net/)]! 🙏
Support the ClassicPress project by making a [[donation](https://donate.classicpress.net/)]! 🙏