Thank you for considering contributing to AFQ-Browser!
Improving documentation, triaging bugs, creating examples, and writing tutorials are all examples of helpful contributions that you can make
If you want to report a bug or another issue with the software, please do so by adding an issue here. Please be sure to give us detailed information: what did you do when you ran into an issue? What operating system are you using? What browser? Tell us about the data that you are visualizing.
If you are interested in creating new features, please create an issue for discussion first. Once we've hashed it out together, go ahead and create a Pull Request (see this post for instructions.
For something that is bigger than a one or two line fix:
- Create your own fork of the code
- Do the changes in your fork
- If you like the change and think the project could use it:
- Please be sure that your Python code is formatted according to PEP8
- Make sure to document functions you create. We follow the Numpy documentation standards for Python function doc-strings
- Write tests: we use pytest to test Python code. Travis will automatically test your code when you submit a PR.
If you have any questions about any of this, feel free to get in touch through our mailing list: [email protected]