Contributing to ODL¶
Great that you want to help making ODL better! There are basically two ways how you can contribute: as a user or as a developer.
The best way to make contributions as a user is to play around with the software, try to use it for your purposes and get back to us if you encounter problems or miss features. When this happens, take a look at our issue tracker, and if there is no existing issue dealing with your problem, create a new one. Don’t be shy – use the issue tracker to ask questions, too.
If you are a developer and want to contribute code, you may want to read through the subsequent instructions. If you are experienced with Git, you may want to skip directly to the development workflow section.
This documentation is intended for contributions to core ODL. For experimental contributions or extensions that would be too specialized for core ODL, we have the odl/contrib directory that offers a “fast lane” with a more relaxed code quality and consistency policy.
- Extending ODL
- How to document
- Testing in ODL
- The ODL release process
- 1. Agree on a release schedule
- 2. Make sure tests succeed and docs are built properly
- 3. Make a release branch off of
- 4. Bump the
masterbranch to the next development version
- 5. Compile and publish the release
- 6. Create packages for PyPI and Conda
- 7. Test installing the PyPI packages and check them
- 8. Upload the packages to the official locations
- Working with ODL source code
- Install Git
- Following the latest source
- Making a patch
- Git for development
- Git resources