Help wanted! We'd love your contributions to stricto. Please review the following guidelines before contributing. Also, feel free to propose changes to these guidelines by updating this file and submitting a pull request.
Please don't open a GitHub issue for questions about how to use stricto, as the goal is to use issues for managing bugs and feature requests. Issues that are related to general support will be closed and redirected to our gitter room.
For all support related questions, please use discussions.
If you've identified a bug in stricto, please submit an issue to our GitHub repo: bwallrich/stricto. Please also feel free to submit a Pull Request with a fix for the bug!
All feature requests should start with submitting an issue documenting the user story and acceptance criteria. Again, feel free to submit a Pull Request with a proposed implementation of the feature.
If you are not sure, go to discussions
Before submitting a new issue, please search the issues to make sure there isn't a similar issue doesn't already exist.
Assuming no existing issues exist, please ensure you include required information when submitting the issue to ensure we can quickly reproduce your issue.
We may have additional questions and will communicate through the GitHub issue, so please respond back to our questions to help reproduce and resolve the issue as quickly as possible.
New issues can be created with in our GitHub repo.
Pull requests should target the master branch. Please also reference the issue from the description of the pull request using special keyword syntax to auto close the issue when the PR is merged. For example, include the phrase fixes #14 in the PR description to have issue #14 auto close.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Here are only one point to keep it mind : pylint is strict in ci-cd. Your code must be compliant 100% to it (otherwise your push/pull will be rejected).
Please use sparingly
# pylint: disable something...By contributing your code, you agree to license your contribution under the terms of the MIT License.
All files are released with this licence.