CONTRIBUTING.md

Basic Contribution Instructions

sg2t is an open source python package, and the source code is available in the sg2t Github repository. New contributions and contributors are very welcome! Do not hesitate to reach out to the maintainers if you have any questions/concerns.

Reporting bugs / requesting a new feature

If you would like to report a bug or request a new feature, this can be done by opening a new issue.

Contributing code

If you would like to contribute code, this is done by submitting a pull request to the "main" branch of slacgismo/sg2t. If you are also new to git, please refer to the git reference manual for an overview of git basics.

To submit a pull request, we recommend the following workflow:

1. Fork and clone the sg2t repository
2. Create a new branch for your changes
3. Follow the installation instruction for sg2t development (run pip install -e .)
4. Make code changes
5. Open a pull request