Skip to content

Latest commit

 

History

History
153 lines (102 loc) · 5.56 KB

CONTRIBUTING.md

File metadata and controls

153 lines (102 loc) · 5.56 KB
Raw

Contributing

Thanks for your interest in helping improve Aim! 🎉

Before Contributing

As with most projects, prior to starting to code on a bug fix or feature request, please post in the respective GitHub issue saying you want to volunteer, and then wait for a positive response. And if there is no issue for it yet, create it first.

This helps make sure:

  1. Two people aren't working on the same thing.
  2. This is something Aim's maintainers believe should be implemented/fixed.
  3. Any API, UI, or deeper architectural changes that need to be implemented have been fully thought through by the community together with Aim's maintainers.

Please follow Aim Contributor Covenant Code of Conduct in all your interactions with the project.

Governance

This section describes governance processes we follow in developing Aim.

Persons of Interest

Authors

Primary Maintainers

Core Contributors

Releases

We release a new minor version (e.g., 3.8.0) every three to four week and patch releases on demand. The minor versions contain new features, bugfixes and also all previous bugfixes included in previous patch releases. With every release, we publish a CHANGELOG where we list enhancements and fixes. The versioning scheme we use is SemVer.

Contribution Process

The Aim contribution process starts with filing a GitHub issue. Aim defines six categories of issues: enhancements (feature requests), bug reports, code health improvements, peformance improvements, tests, questions.

Aim maintainers actively triage and respond to GitHub issues. In general, we recommend waiting for feedback from an Aim maintainer or community member before proceeding to implement a feature or patch. This is particularly important for significant changes, and will typically be labeled during triage with phase / exploring.

After you have agreed upon an implementation strategy for your feature or patch with an Aim maintainer, the next step is to introduce your changes as a pull request against the Aim Repository.

Once your pull request against the Aim Repository has been merged, your corresponding changes will be automatically included in the next Aim release. Every change is listed in the Aim release notes and CHANGELOG.

Congratulations, you have just contributed to Aim. We appreciate your contribution!

Developing and Testing

The majority of the Aim product areas is developed in Python/Cython. This includes the Storage, SDK, Tracking Server, CLI, API. Aim UI is a Web app mostly built with TypeScript and React.

Developing Storage/SDK/CLI

Most of the backend components, including SDK, Storage, Web APIs and CLI are developed using Python/Cython. In order to start development you must install dev requirements and the aim package itself, in editable mode.

pip install -r requirements.dev.txt
pip install -e .

Verify that Aim installed properly by running

aim version

or by importing aim in python REPL

import aim

Style Guide

Aim follows PEP8 standard for style guide and uses flake8 as a style checker. Style checks enforced as a check on GitHub Actions when new PR opened.

Testing Requirements

New unit-tests must be added along with the code changes. In order to setup the testing environment

cd tests
pip install -r requirements.txt

Aim python code unit-tests are located at tests/ directory. Unit-tests are written in Python's unittest package style. Pytest is used as a test runner/discovery tool. To make sure unit-tests are not failing run

pytest tests/

Developing UI

Aim UI is written in TypeScript. npm is required to build Aim UI and to run in DEV mode. You can verify that npm is on the PATH by running npm -v, and install npm if needed.

Style Guide

We use Prettier to autoformat code on presubmit.

Launching the Development UI

Before running the Aim UI dev server or building a distributable wheel, install npm dependencies via:

cd aim/web/ui
npm install

Then you can start the dev server:

npm start

Aim UI will show logged data in at http://localhost:3000.

Adding New Components

To start building a new component you can run following command:

npm run crc 'ComponentName'

If you want to add a component inside UI kit you can run following command:

npm run crc-kit 'ComponentName'

These command will create a folder named ComponentName with all the necessary files.

Writing Docs

Aim documentation is built using Sphix and is hosted at Read the Docs. The documentation sources are located at docs/ directory. In order to build documentation locally run the following commands

pip install -r requirements.dev.txt
cd docs
pip install -r requirements.txt
make html

Documentation will be available at docs/build/html/index.html on your local machine.