-
Notifications
You must be signed in to change notification settings - Fork 3
Contributing Guide
Note: this guide is loosely based on https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62
We welcome input from anyone - whether you're a user or developer, or someone who would like to be either! You do not have to write code to contribute to Ot2Rec.
Things that would really help Ot2Rec's development include:
- Reporting bugs
- Writing tutorials
- Requesting features
- Submitting pull requests
- Citing us
- Trying Ot2Rec for yourself
If you'd like to start a conversation, please raise an issue.
We use github to host code, to track issues and feature requests, as well as accept pull requests.
All changes to the codebase start with a pull request. If you've never made a pull request before, here is a useful guide you can use. Please document why you've made the changes and how you've done them, you can have a look at some of our old pull requests for an example.
We also review pull requests in the open, it helps us and future developers understand why we made those design choices. Please don't let this be a barrier to contributing, we want to be as encouraging as possible and help us all write better code.
What to write in our Github issues?
tldr; to contact us please open a new issue.
If you'd like to:
It would be best if you include
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
Open a new issue and ask away. Context is very helpful here so please be descriptive!
Open a new issue. Please include:
- Why would this be useful to Ot2Rec users?
- If you have ideas, how would it be implemented?
If you'd like to write a tutorial, or become a contributor, the best way to get to us is to open a new issue.