diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..d2cfdfdf9357c76f5726d9e8b7249a1d2076671b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +Contributions are very welcome. The easiest way is to fork the repo and then +make a pull request from your fork. Before your pull request is merged, it will +be reviewed by at least one person. There may be feedback so expect comments on +the pull request. Add yourself to the AUTHORS file in your first pull request. + +Please review: + +* [Python Guidelines](https://github.com/edx/edx-platform/wiki/Python-Guidelines) +* [Javascript Guidelines](https://github.com/edx/edx-platform/wiki/Javascript-Guidelines) +* [Testing](https://github.com/edx/edx-platform/blob/master/docs/internal/testing.md) + +Coding conventions should be followed and your commit should *increase* test +coverage, not decrease it. For more involved contributions, you may want to +discuss your intentions on the mailing list *before* you start coding. + +Before your first pull request is merged, you'll need to sign the +[individual contributor agreement](http://code.edx.org/individual-contributor-agreement.pdf) +and send it in. This confirms you have the authority to contribute the code in +the pull request and ensures we can relicense it. + +If you have any questions, please ask on the +[mailing list](https://groups.google.com/forum/#!forum/edx-code). diff --git a/README.md b/README.md index 0261f87b46b0257fb6b7dd9400140b3c4c9f0f16..a595e306c2fbb95bb61783bf0a1b097793bf1007 100644 --- a/README.md +++ b/README.md @@ -345,9 +345,9 @@ with `overview.md` to get an introduction to the architecture of the system. How to Contribute ----------------- -Contributions are very welcome. The easiest way is to fork this repo, and then -make a pull request from your fork. The first time you make a pull request, you -may be asked to sign a Contributor Agreement. +Contributions are very welcome. + +Please read [How To Contribute](https://github.com/edx/edx-platform/wiki/How-To-Contribute) for details. Reporting Security Issues -------------------------