From f1ea1cdc57ea9e7a6e372a7e2005162c2618bdf7 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Wed, 3 Apr 2019 10:35:12 +0530 Subject: [PATCH 1/4] Rewrite contributing guide to ReST --- CONTRIBUTING.md | 40 ---------------------------------- CONTRIBUTING.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 40 deletions(-) delete mode 100644 CONTRIBUTING.md create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 21bd7b5b..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,40 +0,0 @@ -# Contributing - -All contributions are much welcome and greatly appreciated! Expect to be credited for you effort. - - -## General - -Generally try to limit the scope of any Pull Request to an atomic update if possible. This way, it's much easier to assess and review your changes. - -You should expect a considerably faster turn around if you submit two or more PRs instead of baking them all into one major PR. - - -## Pull Request Guidelines - -Before you submit a pull request, check that it meets these guidelines: - -1. All the pull requests are made against `master` branch. - -2. The pull request should include tests. - -3. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md. - -4. The pull request containing UI changes should have screen shots. - -5. If you are already not added to `CONTRIBUTORS.txt`, please add yourself in :) - -## Conventions - -- Read and pay attention to current code in the repository -- For the Python part, we follow pep8 in most cases. We use [`flake8`](http://flake8.readthedocs.org/en/latest/) to check for linting errors. Once you're ready to commit changes, check your code with `flake8` with this command - - - flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 / - -If there is any error, fix it and then commit. - -- For the Django part, we follow standard [Django coding style](https://docs.djangoproject.com/en/1.7/internals/contributing/writing-code/coding-style/). - -- If you are changing/creating any model, use `./manage.py makemigrations ` to generate the migrations. Send PR. Let other's review the models. - -- And always remember the Zen. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..22c7e3ec --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,56 @@ +Thank you for your interest in contributing to Junction. We welcome all +contributions and greatly appreciate your effort! + +Bugs / Feature Requests +----------------------- + +If you have found any bugs or would like to request a new feature, please do +check if there is an existing issue already filed for the same, in the +project's GitHub `issue tracker`_. If not, please file a new issue. + +Issue Workflow +-------------- + +Choose an issue from the `issue tracker`_ to work on and claim it by posting +a comment saying "I would like to work on this.". Feel free to ask any doubts +in the issue thread. + +Once you have implemented the feature to an extent, go ahead and file a pull +request, following the tips below. File a pull request early to get as much +feedback early as possible. + +Pull Requests Tips +------------------ + +Pull Requests should be small to facilitate easier review. Keep them +self-contained, and limited in scope. Studies have shown that review quality +falls off as patch size grows. Sometimes this will result in many small PRs to +land a single large feature. + +Checklist: + +1. All pull requests *must* be made against the ``master`` branch. +2. Include tests for any functionality you implement. Any contributions helping + improve existing tests is welcome. +3. Update documentation as necessary and provide documentation for any new + functionality. +4. In case of UI changes, please include screenshots. +5. Add yourself to ``CONTRIBUTORS.txt`` if you're not there already. :) + +Code Convention +--------------- + +We follow the `Django Coding Style`_ and enforce it using `flake8`_. + +In general, if flake8 is happy with your code, you should be fine. To use +``flake8`` to check your code, you can use the following command:: + + $ flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 / + +If you do make any changes to models (modification or addition), make sure to +run ``python manage.py makemigrations`` to enable the server to migrate existing +data to the new models. + +.. _`issue tracker`: https://github.com/pythonindia/junction/issues +.. _`flake8`: https://flake8.readthedocs.org/en/latest/ +.. _`Django Coding Style`: https://docs.djangoproject.com/en/2.2/internals/contributing/writing-code/coding-style/ From 970a4c2a621f8bfdb6fed6281fda0844c99283d2 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Wed, 3 Apr 2019 15:05:47 +0530 Subject: [PATCH 2/4] Simplify CONTRIBUTING.rst --- CONTRIBUTING.rst | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 22c7e3ec..7885cacc 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,26 +1,23 @@ Thank you for your interest in contributing to Junction. We welcome all contributions and greatly appreciate your effort! -Bugs / Feature Requests ------------------------ +Bugs and Features +----------------- If you have found any bugs or would like to request a new feature, please do check if there is an existing issue already filed for the same, in the project's GitHub `issue tracker`_. If not, please file a new issue. -Issue Workflow --------------- - -Choose an issue from the `issue tracker`_ to work on and claim it by posting -a comment saying "I would like to work on this.". Feel free to ask any doubts -in the issue thread. +If you want to help out by fixing bugs, choose an issue from the `issue +tracker`_ to work on and claim it by posting a comment saying "I would like to +work on this.". Feel free to ask any doubts in the issue thread. Once you have implemented the feature to an extent, go ahead and file a pull -request, following the tips below. File a pull request early to get as much -feedback early as possible. +request, following the tips below. File a pull request early to get feedback as +early as possible. -Pull Requests Tips ------------------- +Pull Requests +------------- Pull Requests should be small to facilitate easier review. Keep them self-contained, and limited in scope. Studies have shown that review quality @@ -37,6 +34,10 @@ Checklist: 4. In case of UI changes, please include screenshots. 5. Add yourself to ``CONTRIBUTORS.txt`` if you're not there already. :) +If you do make any changes to models (modification or addition), make sure to +run ``python manage.py makemigrations`` to enable the server to migrate existing +data to the new models. + Code Convention --------------- @@ -47,10 +48,6 @@ In general, if flake8 is happy with your code, you should be fine. To use $ flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 / -If you do make any changes to models (modification or addition), make sure to -run ``python manage.py makemigrations`` to enable the server to migrate existing -data to the new models. - .. _`issue tracker`: https://github.com/pythonindia/junction/issues .. _`flake8`: https://flake8.readthedocs.org/en/latest/ .. _`Django Coding Style`: https://docs.djangoproject.com/en/2.2/internals/contributing/writing-code/coding-style/ From 651d991549ea5d18f456b6ec2b2acb6add8ebf6d Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Tue, 10 Mar 2020 15:30:34 +0530 Subject: [PATCH 3/4] Move contributing file into .github --- CONTRIBUTING.rst => .github/CONTRIBUTING.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTING.rst => .github/CONTRIBUTING.rst (100%) diff --git a/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst similarity index 100% rename from CONTRIBUTING.rst rename to .github/CONTRIBUTING.rst From 8f1435d885ffdbaee6bd925a69b01ec9c360c6c5 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Thu, 19 Mar 2020 23:54:47 +0530 Subject: [PATCH 4/4] Address review comments --- .github/CONTRIBUTING.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 7885cacc..ec7ed753 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -5,16 +5,16 @@ Bugs and Features ----------------- If you have found any bugs or would like to request a new feature, please do -check if there is an existing issue already filed for the same, in the -project's GitHub `issue tracker`_. If not, please file a new issue. +check in the project's GitHub `issue tracker`_, if there is a similar existing +issue already filed. If not, please file a new issue. If you want to help out by fixing bugs, choose an issue from the `issue tracker`_ to work on and claim it by posting a comment saying "I would like to work on this.". Feel free to ask any doubts in the issue thread. Once you have implemented the feature to an extent, go ahead and file a pull -request, following the tips below. File a pull request early to get feedback as -early as possible. +request by following the tips below. File a pull request early to get feedback +as early as possible. Pull Requests ------------- @@ -27,8 +27,8 @@ land a single large feature. Checklist: 1. All pull requests *must* be made against the ``master`` branch. -2. Include tests for any functionality you implement. Any contributions helping - improve existing tests is welcome. +2. Include tests for any functionality you implement. Contributions that + improve existing tests are welcome. 3. Update documentation as necessary and provide documentation for any new functionality. 4. In case of UI changes, please include screenshots.