Skip to content

Latest commit

 

History

History
174 lines (113 loc) · 5.34 KB

CONTRIBUTING.rst

File metadata and controls

174 lines (113 loc) · 5.34 KB
Raw

Contribution getting started

Contributions are highly welcomed and appreciated. Every little help counts, so do not hesitate!

Contribution links

Feature requests and feedback

We'd like to hear about your propositions and suggestions. Feel free to submit them as issues and:

  • Explain in detail how they should work.
  • Keep the scope as narrow as possible. This will make it easier to implement.

Report bugs

Report bugs for amqproto in the issue tracker.

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, specifically Python interpreter version, installed libraries and amqproto version.
  • Detailed steps to reproduce the bug.

Fix bugs

Look through the GitHub issues for bugs. Here is a filter you can use: bug

Implement features

Look through the GitHub issues for enhancements. Here is a filter you can use: enhancement

Write documentation

amqproto could always use more documentation. What exactly is needed?

  • More complementary documentation. Have you perhaps found something unclear?
  • Documentation translations. We currently have only English.
  • Docstrings. There can never be too many of them.
  • Blog posts, articles and such -- they're all very appreciated.

You can also edit documentation files directly in the GitHub web interface, without using a local copy. This can be convenient for small fixes.

Note

Build the documentation locally with the following command:

$ make docs

The built documentation should be available in the docs/en/_build/.

Where 'en' refers to the documentation language.

Preparing Pull Requests on GitHub

Note

What is a "pull request"? It informs project's core developers about the changes you want to review and merge. Pull requests are stored on GitHub servers. Once you send a pull request, we can discuss its potential modifications and even add more commits to it later on.

Note

Prerequisites * python 3.5 * virtualenv venv in the project root (or just an activated virtualenv)

virtualenv -p python3.5 venv (if you don't have virtualenv installed, install it with pip install virtualenv first).

There's an excellent tutorial on how Pull Requests work in the GitHub Help Center, but here is a simple overview:

  1. Fork the amqproto GitHub repository. It's fine to use amqproto as your fork repository name because it will live under your user.

  2. Clone your fork locally using git and create a branch:

    $ git clone [email protected]:YOUR_GITHUB_USERNAME/amqproto.git
$ cd amqproto
# now, to fix a bug create your own branch off "master":

    $ git checkout -b your-bugfix-branch-name master

# or to instead add a feature create your own branch off "feature":

    $ git checkout -b your-feature-branch-name feature

    Given we have "major.minor.micro" version numbers, bugfixes will usually be released in micro releases whereas features will be released in minor releases and incompatible changes in major releases.

    If you need some help with Git, follow this quick start guide: https://git.wiki.kernel.org/index.php/QuickStart

  3. Run unit tests:

    $ make unittests

  4. Run integration tests:

    You need to have rabbitmq up (with management plugin enabled) and listening on 5672 and 15672 ports. If you have docker installed, we will start a rabbitmq server automatically.

    $ make integrationtests

  5. Check code style compliance:

    $ make codestyle-check

  6. You can now edit your local working copy.

    You can now make the changes you want and run the tests again as necessary.

  7. Make sure your code is formatted properly, run:

    $ make codestyle-autoformat

    This command will change files in your repository if necessary. Inspect git diff output, make sure it didn't break your changes (generally it shouldn't) by running tests again.

  8. Commit and push once your tests pass and you are happy with your change(s):

    $ git commit -a -m "<commit message>"
$ git push -u

    Make sure you add a message to CHANGELOG.rst. You will be added automatically to AUTHORS on the next release (commit author identity will be used which you can set using git config user.name command). If you are unsure about either of these steps, submit your pull request and we'll help you fix it up.

  9. Finally, submit a pull request through the GitHub website using this data:

    head-fork: YOUR_GITHUB_USERNAME/amqproto
compare: your-branch-name

base-fork: malinoff/amqproto
base: master          # if it's a bugfix
base: feature         # if it's a feature