The general way to contribute to Asteroid is to fork the main repository on GitHub:
- Fork the main repo and
git cloneit. - Make your changes, test them, commit them and push them to your fork.
- You can open a pull request on GitHub when you're satisfied.
If you made changes to the source code, you'll want to try them out without
installing asteroid everytime you change something.
To do that, install asteroid in develop mode either with pip
pip install -e .[tests] or with python python setup.py develop.
All contributions to the source code of asteroid should be documented
and unit-tested.
See here to run the tests with coverage reports.
Docstrings follow the Google format, have a look at other
docstrings in the codebase for examples. Examples in docstrings can
be bery useful, don't hesitate to add some!
Most new recipes should follow the standard format that is described
here. We are not dogmatic about it, but another organization should
be explained and motivated.
We welcome any recipe on standard or new datasets, with standard or new
architectures. You can even link a paper submission with a PR number
if you'd like!
If you found a typo, think something could be more explicit etc...
Improving the documentation is always welcome. The instructions to install
dependencies and build the docs can be found here.
Docstrings follow the Google format, have a look at other
docstrings in the codebase for examples.
We use PEP8 syntax conventions. To make your life easier, we recommend running a PEP8 linter:
- Install PEP8 packages:
pip install pep8 pytest-pep8 autopep8 - Run a standalone PEP8 check:
py.test --pep8 -m pep8
If you have any question, open an issue or join the slack, we'll be happy to help you.