-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6f90813
commit c3828a1
Showing
1 changed file
with
33 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| How To Contribute | ||
| ================= | ||
|
|
||
| We would love to have contributions from everyone. No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can! | ||
| We would love to have contributions from everyone and no contribution is too | ||
| small. Please submit as many fixes for typos and grammar bloopers as you can! | ||
|
|
||
| To make participation in this project as pleasant as possible for everyone, we adhere to the `Code of Conduct`_ by the Python Software Foundation. | ||
| To make participation in this project as pleasant as possible for everyone, | ||
| we adhere to the `Code of Conduct`_ by the Python Software Foundation. | ||
|
|
||
| The following steps will help you get started: | ||
|
|
||
| Fork, then clone the repo: | ||
| :: | ||
| Fork, then clone the repo::: | ||
|
|
||
| git clone [email protected]:your-username/ripe-atlas-tools.git | ||
|
|
||
| Make sure the tests pass beforehand: | ||
| :: | ||
| Make sure the tests pass beforehand::: | ||
|
|
||
| tox | ||
|
|
||
|
|
@@ -23,8 +23,7 @@ or | |
|
|
||
| nosetests tests/ | ||
|
|
||
| Make your changes. Add tests for your change. Make the tests pass: | ||
| :: | ||
| Make your changes. Include tests for your change. Make the tests pass::: | ||
|
|
||
| tox | ||
|
|
||
|
|
@@ -36,24 +35,35 @@ or | |
|
|
||
| Push to your fork and `submit a pull request`_. | ||
|
|
||
| Here are a few guidelines that will increase the chances of a quick merge of your pull request: | ||
| Here are a few guidelines that will increase the chances of a quick merge of | ||
| your pull request: | ||
|
|
||
| - *Always* try to add tests and docs for your code. If a feature is tested and documented, it's easier for us to merge it. | ||
| - *Always* try to add tests and docs for your code. If a feature is tested and | ||
| documented, it's easier for us to merge it. | ||
| - Follow `PEP 8`_. | ||
| - Write `good commit messages`_. | ||
| - If you change something that is noteworthy, don't forget to add an entry to the changes_. | ||
| - If you change something that is noteworthy, don't forget to add an entry to | ||
| the `changes`_. | ||
|
|
||
| .. note:: | ||
| - If you think you have a great contribution but aren’t sure whether it adheres -- or even can adhere -- to the rules: **please submit a pull request anyway**! In the best case, we can transform it into something mergable, in the worst case the pull request gets politely closed. There’s absolutely nothing to fear. | ||
| - If you have a great idea but you don't know how or you don't have time to implement it, please consider opening an issue and someone will pick it up as soon as it's possible. | ||
|
|
||
|
|
||
| Thank you for considering to contribute to our tool! | ||
| If you have any question or concerns, feel free to reach out the RIPE Atlas team. | ||
|
|
||
|
|
||
| .. _`submit a pull request`: https://github.com/RIPE-NCC/ripe-atlas-tools/compare/ | ||
| .. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/ | ||
| .. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
| .. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/ | ||
| - If you think you have a great contribution but aren’t sure whether it | ||
| adheres -- or even can adhere -- to the rules: **please submit a pull | ||
| request anyway**! In the best case, we can transform it into something | ||
| usable, in the worst case the pull request gets politely closed. There’s | ||
| absolutely nothing to fear. | ||
| - If you have a great idea but you don't know how or don't have the time to | ||
| implement it, please consider opening an issue and someone will pick it up | ||
| as soon as possible. | ||
|
|
||
| Thank you for considering a contribution to this project! If you have any | ||
| question or concerns, feel free to reach out the RIPE Atlas team via the | ||
| `mailing list`_, `GitHub Issue Queue`_, or `messenger pigeon`_ -- if you must. | ||
|
|
||
| .. _submit a pull request: https://github.com/RIPE-NCC/ripe-atlas-tools/compare/ | ||
| .. _PEP 8: https://www.python.org/dev/peps/pep-0008/ | ||
| .. _good commit messages: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
| .. _Code of Conduct: https://www.python.org/psf/codeofconduct/ | ||
| .. _changes: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CHANGES.rst | ||
| .. _mailing list: https://www.ripe.net/mailman/listinfo/ripe-atlas | ||
| .. _GitHub Issue Queue: https://github.com/RIPE-NCC/ripe-atlas-tools/issues | ||
| .. _messenger pigeon: https://tools.ietf.org/html/rfc1149 | ||