Welcome to our nascent brainconn repo... we appreciate your contributions to this exciting new tool for applying graph theory using Python.
The following guidelines will streamline the process of getting acclimated to the project. If there is anything we failed to cover, please feel free to let us know by opening an issue.
Are you new to GitHub and its esoteric ways? First you'll need to set up a free GitHub account and sign in. Here are some instructions.
Perhaps you are veteran GitHub user and know your stuff? Click the links below to get started:
brainconn is an independent fork of bctpy, which is itself a Python implementation of the BCT MATLAB toolbox.
With all love to Roan LaPlante and his excellent tool, there were a number of elements we sought to change. Therefore, we chose to develop our ideas independently from his original project fork.
As with most repositories on GitHub, most communications will be through open issues.
When crafting your contributions to brainconn, please be mindful of our code of conduct.
The current list of labels are here and include:
-
Tasks our members have identified as perfect for new contributors.
If you can defeat any of these, we encourage you to slay the issue!
-
These issues point to problems in the project.
If you happen upon an unknown bug, please provide as much information as possible in your issue, including all steps necessary to recreate the error. If you encounter one of our known bugs in the wild, please provide a comment to document any fresh observations.
-
Requests for specific enhancements to be added to the project.
Please try to make sure your enhancement is unique and not already requested or implemented. If you find a similar request with minor alterations, please reference that request in your issue.
Rest assured that while we appreciate all contributions to brainconn, for simplicity's sake, we prefer the following workflow:
1. Comment on the present issue or create a new issue explaining your addition.
We're all about communication... and adherence to this guideline will help the development team ensure your efforts and those of other members are not redundant. Further, it will ensure your proposed contribution is in harmony with other elements of the project.
This blog provides an explanation of why an ounch of communication is worth a day of frustrated programming.
2. Fork the brainconn repository to your GitHub profile.
This is your own personal brainconn playground. Any changes in here are isolated, so it's the perfect place to experiment and explore the code.
Make it a habit to keep your fork up to date with the master repository. You don't want to make your important changes to an outdated version of the code.
3. Follow through and make the changes.
As programmers, we're definitely familiar with the temptation to fix everything at once. Despite this urge, do your best to keep your changes focused. A good tip: work on a new branch to keep your current changes targeted.
Please make sure to review the brainconn style conventions when creating your pull request.
4. Submit your pull request.
You've done your part, and now a member of the development team will review your changes to confirm they can be merged into the main codebase.
We welcome and recognize all contributions... from documentation to testing to code development. You can see a list of current contributors in the contributors tab.
— Based on contributing guidelines from the STEMMRoleModels project.