From ca1f4bad7d6d265be7bf8e7d45c5c617d8e6d44f Mon Sep 17 00:00:00 2001 From: James Tauber Date: Mon, 16 Sep 2013 16:50:08 -0400 Subject: [PATCH] Moved to a more comprehensive contributing doc. Based on the How To Contribute wiki page (and switched to markdown so it's a simple copy-paste). --- CONTRIBUTING.md | 13 +++++++++++++ CONTRIBUTING.rst | 6 ------ 2 files changed, 13 insertions(+), 6 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..24dcf4673c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +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]] +* [[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/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 146e4f09fc..0000000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,6 +0,0 @@ -How To Contribute -================= - -Contributions are very welcome. - -Please read `How To Contribute `_ for details.