Hello dear contributor-to-be! 👋
Awesome to see that you're considering to contribute to ASReview! Below you will find some guidelines for your future contributions.
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:
Is something not working as expected 🤔?
Create an issue and select Bug report 🐛.
Do you have a suggestion (and may want to implement it 🙂)?
Create an issue and use the 🚀 Feature request template.
Want to try to fix the bug you found? Build your feature request yourself? Brilliant! 😍 You can submit your changes to ASReview by creating a pull request.
- Improve the 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.
- Looking to develop your own extension? 🔌
- See create extensions for detailed instructions.
- See the current list of extensions
Got any questions for the ASReview community? Or perhaps you know the answer to a question asked? 💡 Don't hesitate to post on the discussion board.
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.
Your pull request will be carefully reviewed by the maintainers. They will get back at you as soon as possible and possibly start integrating your suggestions and/or contributions into the project.
If you have any more questions, do not hesitate to send an e-mail to asreview@uu.nl. You can also sign up for the newsletter for the latest updates on ASReview straight to your inbox! 📧
Thanks again for your contribution, the ASReview team. 💛