We're so glad you're thinking about contributing to ScubaGear! If you're unsure or hesitant to make a recommendation, just ask, submit the issue, or pull request. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution(s), and don't want a wall of rules to stifle innovation.
Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which are in this repository.
If you want to report a bug or request a new feature, the most direct method is to create an issue in this repository. We recommend that you first search through existing open and closed issues to check if your particular issue has already been reported.
If it has then you might want to add a comment to the existing issue.
If it hasn't then feel free to create a new one.
Please follow the provided template and fill out all sections.
We have Bug Report and Idea templates.
If you choose to submit a pull request, it must pass several style, format, and sanity checks in our continuous integration (CI) pipeline before it can be merged. Your pull request may fail these checks, and that's OK. If you want you can stop there and wait for us to make the necessary corrections to ensure your code passes the CI checks. If you would rather make the changes yourself to pass the CI checks, please feel free to do so.
All PRs will be tested, vetted, and reviewed by our team before being merged to the main branch. Please stand by to address questions, concerns, or improvement suggestions we may have about your PR.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.