Contributing to aeon#

aeon is a community-driven project and contributions are most welcome. We value all kinds of contributions, not just code. Improvements to docs, bug reports, and taking on communications or code of conduct responsibilities are all examples of valuable contributions beyond code which help make aeon a great package.

In the following we will give a brief overview of how to contribute to aeon. Making contributions to open source projects takes a bit of proactivity and can be daunting at first, but members of the community are here to help and answer questions. If you get stuck, please don’t hesitate to talk with us or raise an issue.

Recommended steps for first time contributors, or to get started with regular contributions:

  1. Say hello in the introductions or contributors channel on Slack and mention which places you are interested in contributing to.

  2. Get setup for development, see the developer install instructions for creating a fork of aeon.

  3. Pick an enhancement, documentation or maintenance issue to complete i.e. improving an algorithm, docstring or test. The good first issue list may be a good place to start.

  4. Create a pull request (PR) with your changes from your fork. For help, see the GitHub documentation or ask in Slack. Follow the PR template and checklist.

  5. A core developer will review your PR and may provide feedback, which you can then address. If you are unsure about any feedback, please ask for clarification.

  6. Once your PR is approved, it will be merged into the aeon repository. Thanks for making a contribution! Make sure you are included in the list of contributors.

Further guidance for contributing to aeon via GitHub can be found on the developer guide.

If your intended method of contribution does not fit into the above steps, please reach out to us on Slack for discussion. While GitHub contributions are the most common, it is not the only way to contribute to aeon.

Acknowledging Contributions#

We follow the all-contributors specification and recognise various types of contributions. Take a look at our past and current contributors!

If you are a new contributor, make sure we add you to our list of contributors. All contributions are recorded in .all-contributorsrc. Alternatively, you can use the @all-contributors bot to do this for you.

Further Reading#

For further information on contributing to aeon, please see the following pages.

Developer Guide

Guidance for aeon developers on a range of topics.

Enhancement Proposals

Information on contributing aeon enhancement proposals.

Reporting Bugs

Guidance for reporting bugs in aeon.

Reviewer Guide

Guidance for reviewing aeon pull requests.