How to contribute
Doc Detective welcomes contributions of all sorts. If you can't contribute code, you can still help by reporting issues, suggesting new features, improving the documentation, or sponsoring the project.
Report issues
If you find a bug, report it on the Doc Detective issue tracker. If you know which repo the bug appears in, open it in that project's specific tracker.
Make sure to include as much information as possible, such as the version of Doc Detective you're using, the operating system you're on, and any error messages you see.
Contribute code or docs
Before any code or doc contributions are accepted, you need to sign the contributor license agreement (CLA). This agreement makes sure that your contributions are properly licensed and maintains the project's open-source status and ongoing health.
- Fork the repo you want to contribute to.
- Create a new branch.
- Make your changes.
- Submit a pull request to the project or
rc(release candidate) branch. - Wait for your pull request to be reviewed. All discussions regarding the pull request will be conducted on GitHub.
- Make any necessary changes to your pull request.
- Your pull request will be merged if it is reviewed and approved.
Other contributions
If there's something you'd like to contribute that isn't covered here, drop by the Discord server and let us know. We're always open to new ideas and ways to improve the project.