Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

78 lines (47 loc) · 2.97 KB
Raw

Contributing Guidelines

Successfully collaborating on common problems is always an edifying experience that increases the desire to do more.

Pull Requests

Before Submitting

Some recommendations to help align your contribution and minimise the eventual back and forth on a PR:

  • Engage in an issue thread or in the discussion section.
  • Actual code in the form of a minimal PR with a status:do_not_merge label is a great tool for generating useful dialogue.

Which Branch?

  • If it's a new feature, or bugfix applicable to the latest code, devel
  • If it's a bugfix that can't be applied to devel, but critical for a release, point it at the release branch (e.g. release/0.6.x)

If it is a feature or bugfix that you'd like to see backported to one of the release branches, open a parallel PR for that release branch or mention that you'd like to see it backported in the original PR's description.

Coding

Running . ./venv.bash in the root of the repository can create a nice, self-contained sandbox within which you can develop and test your contribution.

The Pull Request

Be sure to state clearly in the pull request's description (this helps expedite review):

  • The motivation, i.e. what problem is this solving.
  • A concise summary of what was done (and why if relevant).

Apply relevant labels - one of component & type is the norm. If the pull request is not yet ready, use the status:do_not_merge label.

Style

The repository aims to conform to PEP8, please endeavour to do so. There is a simple script ./lint/flake8 that can be used to check that the code conforms. This is run as part of the CI checks.

Tests

See tests/README.md for instructions on how to run the tests all together or manually. If you are contributing new features, or bugfixing a problem that did not have coverage, it is expected that the pull requests will include a test for regression purposes.

Documentation

Documentation is auto-generated as part of the PR process, but if you do wish to make changes and check locally:

. ./venv.bash
make docs
...
The HTML pages are in doc/html.

Changelog

  • Please update the Forthcoming section in the Changelog with your change and a link to your PR.
  • The style should be self-explanatory.
  • Do not worry about incrementing the version, releases are handled separately.

Review

Once submitted, a reviewer will be assigned. You do not need to select. If no-one has self-assigned in a reasonable time window, feel free to append a friendly bump comment to your PR.

Merging

Once the large button has gone GREEN, you or the reviewer may merge the pull request.

Releasing

If you are interested in seeing your changes make it into a release (sooner rather than later) and distributed on PyPi, PPA or via the ROS ecosystem, please make the request via a comment in your PR or in an issue.

Social Conduct

Be prepared to be tickled by noodly appendages and at all times, be froody.