From 79ff2842fa477ee0693ea167c0a74cd7cf080d27 Mon Sep 17 00:00:00 2001 From: Colin Watson Date: Tue, 31 Oct 2017 10:34:41 +0000 Subject: Import py-macaroon-bakery_0.0.3.orig.tar.gz --- CONTRIBUTING.rst | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 CONTRIBUTING.rst (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..2993720 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,104 @@ +============ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every +little bit helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/go-macaroon-bakery/py-macaroon-bakery/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" +is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "feature" +is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +The macaroon bakery could always use more documentation, whether as part of the +official macaroon bakery docs, in docstrings, or even on the web in blog posts, +articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at +https://github.com/go-macaroon-bakery/py-macaroon-bakery/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. + +Get Started! +------------ + +Ready to contribute? Here's how to set up `py-macaroon-bakery` for local +development. + +1. Fork the `py-macaroon-bakery` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/py-macaroon-bakery.git + +3. Prepare your development environment:: + + $ make devenv + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. When you're done making changes, check that your changes pass flake8 and the +tests, including testing other Python versions with tox:: + + $ make check + +6. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. 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.rst. +3. The pull request should work for Python 2.7, 3+ and for PyPy. + +Tips +---- + +To run a subset of tests:: + + $ devenv/bin/nosetests macaroonbakery/tests/... -- cgit v1.2.3