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
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:
Say hello in the
contributorschannel on Slack and mention which places you are interested in contributing to.
Get setup for development, see the developer install instructions for creating a fork of
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.
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.
Once your PR is approved, it will be merged into the
aeonrepository. 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
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
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.
For further information on contributing to
aeon, please see the following pages.
aeon developers on a range of topics.
Information on contributing
aeon enhancement proposals.
Guidance for reporting bugs in
Guidance for reviewing
aeon pull requests.