Developer Guide

Welcome to the aeon developer guide. This guide is intended for new developers who want to start contributing code to aeon and current developers who want to learn about specific topics for code and non-code developments.

The following is a quick checklist for new developers. At any point during the process, feel free to post questions on Slack or ask core developers for help.

• Fork the repository and install a development version of aeon.

• Get familiar with the git workflow.

• Set up Continuous Integration (CI) testing locally and learn how to check the status on pull requests.

• Read up on the aeon coding standards and pre-commit setup.

aeon follows the scikit-learn API whenever possible. If you’re new to scikit-learn, take a look at their getting-started guide. If you’re already familiar with scikit-learn, you may still learn something new from their developer’s guide.

Specific Topics

Below we list further reading and guidance for specific topics in the development of aeon.

• Adding a New Dataset
• Implementing estimators
• Coding standards
• Continuous integration
• Dependencies
• Deprecation Policy
• Developer Installation
• Developing Documentation
• Git and GitHub workflow
• Releases
• Testing framework