π Communityο
Submitting Issues, Ideas, & Suggestionsο
Have an issue? Seeking Support? - Open a GitHub Issue - Shoot me an email! (kyle.gillett@und.edu) - Shoot me a DM on X (@wxkylegillett)
Contributing to SounderPyο
Contributions to this library are encouraged! Below are a few simple guidelines to follow if you are considering helping out this package.
Tackling open issues on Github β feel free to search through unresolved Github Issues and propose a solution!
Contributing your code β if you have made local modifications to SounderPy, feel free to suggest adding your changes by opening a GitHub pull request.
Adding an entirely new feature β similarly to above, open a GitHub pull request with the proposed additions.
Creating tutorials β So much of the code we write is best understood with comprehensive tutorials. I highly encourage anyone to build tutorials that explain the code, explain a specific use/task, or to simply provide more examples. Do so by opening a GitHub pull request.
To contribute to SounderPyβ¦
In GitHub, fork the SounderPy repository (repo) into your profile.
Pull down the forked repo to your local machine.
After making changes, commit them to your forked repo.
Finally, open a Pull Request.
Pull requests, for any contribution, should include a detailed explanation of the code, why itβs needed, and what it fixes/replaces.
Ensure that your code is well formatted, clean, commented and easy to read.
IMPORTANT: The goal of SounderPy is to make sounding analysis available to everyone β beginners and experts alike. As such, SounderPy code should be easy to read, not just well-documented. In the case of this library, code that is clean and easy to read is valued more over code that is βfancyβ, βtoo-complexβ and harder to read.