From 024c1daffa0fbefdf8d68ce8c31e11f2f865b23b Mon Sep 17 00:00:00 2001 From: Andrew Embler Date: Wed, 1 Apr 2020 21:40:02 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a163b92909..11e5155d232 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,36 +6,23 @@ And concrete5 is no exception, so we'd like to thank you for your help. ## What We'd Love Help On -We've tried to categorize our issues in ways that will make it clear how best we can use your help. In general, if something is labelled as "accepted:ready to start" it is ready for development! If you find an issue that is labeled in this way, without a dedicated person assigned to it, post that you'd like to work on it, and go for it. When you're done submit a pull request and we'll review it right away for inclusion. - -We have a lot of items we'd like help on: if you find an issue tagged as "accepted:ready to start" **and** either "priority:like to have" or "priority:love to have" you'll know that this is something we'd really, really like to get. We'd love the assistance. +We've tried to categorize our issues in ways that will make it clear how best we can use your help. In general, if something is labelled as "Available" it is ready for development! If you find an issue that is labeled in this way, without a dedicated person assigned to it, post that you'd like to work on it, and go for it. When you're done submit a pull request and we'll review it right away for inclusion. Helpful Links: -* [Issues ready to be worked on](https://github.com/concrete5/concrete5/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepted%3Aready+to+start%22+no%3Aassignee) -* [New proposals](https://github.com/concrete5/concrete5/issues?q=is%3Aopen+is%3Aissue+label%3A"type%3Arfc") -* [Things under discussion](https://github.com/concrete5/concrete5/issues?q=is%3Aopen+is%3Aissue+label%3Atype%3Adiscussion) +* [Available Issues](https://github.com/concrete5/concrete5/issues?q=is%3Aopen+is%3Aissue+no%3Aassignee+label%3AStatus%3AAvailable) ## Pull Requests -Before submitting pull requests, please be sure to read these pages: +Before submitting pull requests, please be sure to read our extensive guidelines about submitting code to concrete5: -- Adopting a common coding style makes developers life easier and may be helpful in finding some kind of bugs. Furthermore, like @aembler once said, we have to be good citizens: speaking the same dialect is useful for everybody. So, please be sure to consult the [Coding-Style Guidelines](http://documentation.concrete5.org/developers/background/coding-style-guidelines). +https://documentation.concrete5.org/tutorials/submitting-code-to-concrete5 - To fix the coding style of the files you created/modified, simply call: +Need to fix the coding style of your PHP files prior to submissions? Are you working on concrete5 version 9? To fix the coding style of the files you created/modified, simply call: `./concrete/bin/concrete5 c5:phpcs fix ` (On Windows, replace `/` with `\`). Where `` is the file you modified (you can also specify multiple files, as well as using directories). - - Pull requests that address existing issues are much **much** more likely to be accepted than unsolicited pull requests. -- Pull requests should normally be directed at the `develop` branch. Master is reserved for the most recent stable release. [Read more about the gitflow branching model](https://github.com/concrete5/concrete5/issues/1058). - -- If you used to develop for concrete5 Legacy (v5.6 and older), you should read the [Migration Guide](https://github.com/concrete5/concrete5/wiki/Migration-Guide): it explains some of the main differences introduced in concrete5 5.7 and later. - -## Github issues vs Bug tracker - -Github is **not** the place for unconfirmed bugs. If this is an unconfirmed bug (and almost all of them are), they should be posted to the [official concrete5 bug tracker](http://www.concrete5.org/developers/bugs) so that they can be confirmed and voted on. Just because something is posted here does not guarantee it will be placed into a release milestone. **Exceptions** to this rule include issues that are accompanied by a pull request, but even a pull request isn't guaranteed to be accepted into the core. - Thanks everyone!