Hello dear contributor-to-be! 👋
We're happy to see you're considering contributing to ASReview. We'd love to collaborate with you! Below you will find some guidelines for contributing to ASReview.
Your ideas and input are very much appreciated. From contributing to source code to improving readability of the documentation, all suggestions are welcome!
There are multiple ways to contribute:
Found a glitch in the matrix? Please let us know by opening an issue! Make sure to choose the Bug issue template.
Got a suggestion for enhancement of ASReview? Let us know by filing an issue, choosing the Feature request template.
Want to try to fix the bug you found? Build your feature request yourself? Be our guest! 😍 You can submit your changes to ASReview by creating a pull request.
- Improve our documentation. 📝
- Propose a fix to an existing issue.
⚠️ - See the issue list here.
- Add a new dataset to our open dataset repository
- See this pull request) for an example.
Do you have little experience with contributing to open-source project and working with GitHub? 
No worries! There are some amazing tutorials out there:
- First timers only
- See the first-contributions repo for a tutorial on how to contribute code.
- How To Contribute To An Open Source Project on GitHub.
- Mastering Issues by GitHub.
- About Pull Requests by GitHub.
Our maintainers will carefully review your pull request. We get back at you as soon as possible, and hope and integrating your suggestions into our project. We are looking forward to integrating your contributions into ASReview!
If you have any more questions, do not hesitate to send an e-mail to [email protected].
Thanks again for your contribution, the ASReview team. 💛