Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Unifies our disparate contribution guides.

  • Loading branch information...
commit 40af72cdc32fd596350d7b749f8f1a8191bfceb3 1 parent 7881fc1
@ewinslow ewinslow authored
Showing with 44 additions and 21 deletions.
  1. +44 −21 CONTRIBUTING.md
View
65 CONTRIBUTING.md
@@ -1,37 +1,60 @@
## DISCLAIMERS
-* **SECURITY ISSUES SHOULD BE REPORTED TO security @ elgg . org! Please do not post any security issues in trac! **
+* **SECURITY ISSUES SHOULD BE REPORTED TO security @ elgg . org!** Please do not post any security issues in github.
* Support requests belong on the [Community site][2]. Tickets with support requests will be closed.
-* Reports which do not give sufficient detail to diagnose the problem, cannot be reproduced, or are dealing with customized code or third party plugins will be closed!
-* We cannot make any guarantees as to when your ticket will be resolved.
-* **By submitting a patch, language file or plugin you are agreeing to license it under a [GPLv2 license][3] and [MIT license][4].**
+* Reports which do not give sufficient detail to diagnose the problem, cannot be reproduced, or are dealing with customized code or third party plugins will be closed.
+* We cannot make any guarantees as to when your ticket will be resolved.
+* Please search the existing list of issues before submitting new reports.
-## Report a bug
+## Submitting pull requests
-1. Search for an existing ticket on the issue
-2. [Read up][5] on how to submit an awesome ticket.
-3. Email info at elgg dot org to request a new Trac account.
-4. [Create your ticket][6]
-5. [Include a patch][7] (optional, but appreciated)
+We love pull requests! Pull requests will almost always get higher priority than just plain issues.
+Some things to keep in mind:
-## Request a feature
+* **By submitting a pull request you are agreeing to license the code under a [GPLv2 license][3] and [MIT license][4].**
+* You may want to talk to us first before spending a ton of time on code.
+* All code is expected to conform to our [coding standards][9].
+* Include unit tests if possible.
+* Make sure your code can be merged cleanly.
-1. [Check the community site][2] for a plugin that has the features you need
-2. [Develop a plugin][8] that does what you need.
-3. Search for an existing ticket on the issue
-4. [Read up][5] on how to submit an awesome ticket.
-5. Email info at elgg dot org to request a new Trac account.
-6. [Create your ticket][6]
-7. [Include a patch][7] (optional, but appreciated)
+## Bug reports
-## Fix existing bugs
+If you've searched for an existing ticket on the issue you're having, and
+can reproduce the problem on the latest version of Elgg, please submit a
+new issue the following information:
-In addition to reporting bugs and requesting features, actual assistance fixing those bugs and implementing those features is greatly appreciated:
+* Expected behavior and actual behavior.
+* Clear steps to reproduce the problem.
+* The version of Elgg you're running.
+* Browsers affected by this problem, if applicable.
+
+Pull requests for bugfixes should generally be submitted against the most
+recent bugfix branch of Elgg (i.e. not master). If your bug only appears in master,
+then feel free to pull against master.
+
+## Feature requests
+
+Before submitting a feature request, [check the community site][2] for a plugin
+that has the features you need. You may also want to [develop a plugin][8] that
+does what you need. Search through the closed tickets to see if someone else
+suggested the same feature, but got turned down. If they did, you'll need to be
+able to explain why your suggestion should be considered this time. Please include
+as much of the following information as possible, when applicable:
+
+* Detailed explanation of the feature
+* Real-life use-cases.
+* Proposed API
+
+It's usually best to submit a ticket for your feature request first before working
+on code, so that you can know whether we will accept your solution. Once your idea
+has been accepted, pull requests are certainly welcome! Pull requests for features
+should always be made against master. We do not generally introduce new features in
+bugfix branches.
[2]: http://community.elgg.org
[3]: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
[4]: http://en.wikipedia.org/wiki/MIT_License
- [5]: http://docs.elgg.org/wiki/Development/IssueTracker
[6]: https://github.com/Elgg/Elgg/issues/new
[7]: http://docs.elgg.org/wiki/Development/Contributing/Patches
[8]: http://docs.elgg.org/wiki/Plugin_development
+ [9]: https://github.com/Elgg/Elgg/tree/master/documentation/coding_standards
Please sign in to comment.
Something went wrong with that request. Please try again.