From e726ef4c46f6fbcc4ea0c95367fe01dea8744d15 Mon Sep 17 00:00:00 2001 From: James Tauber Date: Mon, 16 Sep 2013 16:30:26 -0400 Subject: [PATCH 1/4] Link to How To Contribute wiki page Created a CONTRIBUTING.rst which GitHub will pick up and included a link to the How To Contribute wiki page there. Also added the same link to the README in the "How To Contribute" section. --- CONTRIBUTING.rst | 6 ++++++ README.md | 6 +++--- 2 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000000..146e4f09fc --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,6 @@ +How To Contribute +================= + +Contributions are very welcome. + +Please read `How To Contribute `_ for details. diff --git a/README.md b/README.md index 0261f87b46..a595e306c2 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 ------------------------- From ca1f4bad7d6d265be7bf8e7d45c5c617d8e6d44f Mon Sep 17 00:00:00 2001 From: James Tauber Date: Mon, 16 Sep 2013 16:50:08 -0400 Subject: [PATCH 2/4] 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. From 9b65a1a90d61ebe7af9ae0eb603d798a413e9a6f Mon Sep 17 00:00:00 2001 From: James Tauber Date: Mon, 16 Sep 2013 17:04:38 -0400 Subject: [PATCH 3/4] Link to wiki with absolute URLs --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24dcf4673c..9bfd04bb93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ Contributions are very welcome. The easiest way is to fork the repo and then mak Please review: -* [[Python Guidelines]] -* [[Javascript Guidelines]] +* [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. From a1693dced7260d366940c21a1e973d53fbec0bcb Mon Sep 17 00:00:00 2001 From: James Tauber Date: Mon, 16 Sep 2013 17:05:57 -0400 Subject: [PATCH 4/4] Added linebreaks. --- CONTRIBUTING.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bfd04bb93..d2cfdfdf93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,7 @@ -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. +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: @@ -6,8 +9,14 @@ Please review: * [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. +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. +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). +If you have any questions, please ask on the +[mailing list](https://groups.google.com/forum/#!forum/edx-code).