Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

65 lines (38 loc) · 2.85 KB
Raw

How to contribute

To guarantee the further evolution of elmada in the long term, we depend on the support of volunteer developers.

Some of the resources to look at if you're interested in contributing:

Licensing

By contributing to elmada, e.g. through opening a pull request or submitting a patch, you represent that your contributions are your own original work and that you have the right to license them, and you agree that your contributions are licensed under the LGPL 3 license.

Submitting bug reports

Open an issue on GitHub to report bugs or other problems.

Submitting changes

To contribute changes:

  1. Fork the project on GitHub
  2. Create a feature branch to work on in your fork (git checkout -b new-fix-or-feature)
  3. Commit your changes to the feature branch after running black to format your code
  4. Push the branch to GitHub (git push origin new-fix-or-feature)
  5. On GitHub, create a new pull request from the feature branch

Pull requests

Before submitting a pull request, check whether you have:

  • Added or updated documentation for your changes
  • Added tests if you implemented new functionality

When opening a pull request, please provide a clear summary of your changes!

Commit messages

Please try to write clear commit messages. One-line messages are fine for small changes, but bigger changes should look like this:

A brief summary of the commit

A paragraph or bullet-point list describing what changed and its impact,
covering as many lines as needed.

Testing

We have existing test coverage for the key functionality of elmada.

All tests are in the elmada/tests directory and use pytest.

Our test coverage is not perfect. An easy way to contribute code is to work on better tests.

Coding conventions

Start reading our code and you'll get the hang of it.

We mostly follow the official Style Guide for Python Code (PEP8).

We have chosen to use the uncompromising code formatter, black. If run from the root directory of this repo, pyproject.toml should ensure the line lengths are restricted to 100. The philosophy behind using black is to have uniform style throughout the project dictated by code. Since black is designed to minimise diffs, and make patches more human readable, this also makes code reviews more efficient.

Attribution

The layout and content of this document is based on the contribution guidelines of the projects OpenGovernment and Calliope.