Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.29 KB

Contributing to DASP-stacker

Help in improving DASP-Stacker is welcome!

If you find a bug or think of an enhancement/improvement you would like to see, feel free to fill out an appropriate issue.

If you have a question, double check that it's not covered in the function documentation found in the readme

The notebooks in the examples directory show the intended use of the functionality provided by the library.

Submitting a PR

If you have added a useful feature or fixed a bug, open a new pull request with the changes. When submitting a pull request, please describe what the pull request is addressing and briefly list any significant changes made. If it's in regards to a specific issue, please include the issue number. Please check and follow the formatting conventions below!

Code Formatting

This project uses the black code formatter.

Any public functions and classes should be clearly documented with google-style docstrings.

Development Setup

mamba env create -f environment.yaml
pre-commit install