Contributing to ASReview
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.
Feel free to propose changes of any kind!
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? Create an issue! Make sure to choose the Bug issue template.
Got a suggestion for enhancement of ASReview? File an issue and use the Feature request template.
Want to try to fix the bug you found?
Build your feature request yourself?
Unsure where to begin? Here are a few examples:
- 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.
Got any questions for the ASReview community?
Or perhaps you know the answer to a question asked?
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.
Life after the pull request
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.
Need more information?
If you have any more questions, do not hesitate to send an e-mail to firstname.lastname@example.org.
Thanks again for your contribution, the ASReview team.