Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/ccurtis7/diff_classifier/issues.
If you are reporting a bug, please include:
- 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 anything labelled "good first issue." These are issues that we think would be especially appropriate for those new to open-source software contribution.
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.
When submitting a new feature, please use a Pull Request with a title and description of the proposed use case. Ideally, new features will include
- Docstrings implemented with the Numpy format
- Unit tests (see examples here)
Diff_classifier could always use more documentation, whether as part of the official afq-insight docs, in docstrings, or even on the web in blog posts, articles, and such.
We appreciate any and all feedback in your own implementations of diff_classifier :)
The best way to send feedback is to file an issue at https://github.com/ccurtis7/diff_classifier/issues.
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 :)