Skip to content

💡Getting started guide for new contributors #3221

@MatthewMiddlehurst

Description

@MatthewMiddlehurst

Information for new contributors

Thank you for your interest in contributing to aeon! We have a lot of resources and guidance on our webpage (https://www.aeon-toolkit.org/en/stable/) which will be useful. If you feel any of these pages are confusing or you spot an error, feel free to open and issue and/or discuss with us on Discord.

For a quick introduction to time series, how we handle time series data types and the modules present in aeon have a look at our getting started page for users.

Before asking to be assigned to an issue, read through our developer installation and contributor guide. We expect a baseline level of experience and the ability to adequately respond to reviews. The project developers are volunteers, and during busy times it may take a while for reviews. Please do not rush to or repeatedly send notifications to potential reviewers.

We provide further guides for dedicated topics in our developer guide page. The most useful ones for most contributors will be the testing and documentation pages. If you are altering public facing code, please make sure that the relevant API page is rendering correctly.

AI usage

aeon will reject PRs which are primarily constructed of LLM output and where AI has been used as a substitute for authorship, understanding, and/or testing. See our AI policy document for general guidelines.

GSoC applicants

aeon is not planning to apply or put up projects for GSoC in 2026.

Metadata

Metadata

Assignees

No one assigned

    Labels

    informationalAn issue or discussion just to relay information. No issue to solve.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions