Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
If you notice a bug or have a feature request, please here. All contributors must abide by our code of conduct.
If you are reporting a bug, please first ensure if there is already an open issue for the same and add your suggestions to minimize redundancy. Otherwise, please include the following information when reporting a new bug:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Please open up an issue here.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include additional tests if appropriate.
- If the pull request adds functionality, the docs should be updated.
- The pull request should work for all currently supported operating systems and versions of Python.
Please note that the suicide_indicator_r project is released with a
Code of Conduct. By contributing to this project you agree to abide by its terms.