Welcome to the Gradec repository!
We're excited you're here and want to contribute.
These guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know by opening an issue!
Before you start you'll need to set up a free GitHub account and sign in. Here are some instructions.
Governance is a hugely important part of any project.
It is especially important to have clear process and communication channels for open source
projects that rely on a distributed network of volunteers, such as Gradec.
Gradec is currently supported by a small group of core developers.
Even with only a couple of individuals involved in decision making processes, we've found that
setting expectations and communicating a shared vision has great value.
By starting the governance structure early in our development, we hope to welcome more people into
the contributing team.
We are committed to continuing to update the governance structures as necessary.
Every member of the Gradec community is encouraged to comment on these processes and suggest
improvements.
As the first project leader, Julio Peraza is ultimately responsible for any major decisions
pertaining to Gradec development.
However, all potential changes are explicitly and openly discussed in the described channels of
communication, and we strive for consensus amongst all community members.
All Gradec community members are expected to follow our
code of conduct during
any interaction with the project.
That includes- but is not limited to- online conversations, in-person workshops or development
sprints, and when giving talks about the software.
As stated in the code, severe or repeated violations by community members may result in exclusion
from collective decision-making and rejection of future contributions to the Gradec project.
Please direct usage-related questions to NeuroStars.
The Gradec developers follow NeuroStars, and will be able to answer your question there.
The current list of labels are here and include:
-
These issues contain a task that a member of the team has determined should require minimal knowledge of the existing codebase, and should be good for people new to the project. If you are interested in contributing to Gradec, but aren't sure where to start, we encourage you to take a look at these issues in particular.
-
These issues contain a task that a member of the team has determined we need additional help with. If you feel that you can contribute to one of these issues, we especially encourage you to do so!
-
These issues point to problems in the project. If you find new a bug, please give as much detail as possible in your issue, including steps to recreate the error. If you experience the same bug as one already listed, please add any additional information that you have as a comment.
-
These issues are asking for new features to be added to the project. Please try to make sure that your requested feature is distinct from any others that have already been requested or implemented. If you find one that's similar but there are subtle differences please reference the other request in your issue.
We appreciate all contributions to Gradec, but those accepted fastest will follow a workflow similar to the following:
1. Comment on an existing issue or open a new issue referencing your addition.
This allows other members of the Gradec development team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out.
This blog is a nice explanation of why putting this work in up front is so useful to everyone involved.
2. Fork Gradec.
Fork the Gradec repository to your profile.
This is now your own unique copy of Gradec. Changes here won't effect anyone else's work, so it's a safe space to explore edits to the code!
Make sure to keep your fork up to date with the main repository.
3. Make the changes you've discussed.
Try to keep the changes focused. We've found that working on a new branch makes it easier to keep your changes targeted.
When you're creating your pull request, please do your best to follow Gradec's preferred style conventions. Namely, documentation should follow the numpydoc convention and code should adhere to PEP8 as much as possible.
4. Submit a pull request.
Submit a pull request.
A member of the development team will review your changes to confirm that they can be merged into the main codebase.
Please use a sentence-case title for the pull request, and do not include any prefixes (e.g., [ENH]), as we now use labels to distinguish pull request types.
The title should summarize the changes proposed in the pull request, with an emphasis on readability, as pull request titles are used directly in our release notes.
We welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors in our zenodo file. If you are new to the project, don't forget to add your name and affiliation there!
You're awesome.