Programming Practices for Research in Students is an open source project, and we welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.
By contributing, you agree that we may redistribute your work under our license. In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved agrees to abide by our code of conduct.
If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub. To manage changes, we follow GitHub flow. Each lesson has one or two maintainers who review issues and pull requests or encourage others to do so. The maintainers have final say over what gets merged into the lesson. To use the web interface for contributing to a lesson:
- Fork the originating repository to your GitHub profile.
- Within your version of the forked repository, move to the
masterbranch and create a new branch for each significant change being made. - Navigate to the file(s) you wish to change within the new branches and make revisions as required.
- Commit all changed files within the appropriate branches.
- Create individual pull requests from each of your changed branches
to the
masterbranch within the originating repository. - If you receive feedback, make changes using your issue-specific branches of the forked repository and the pull requests will update automatically.
- Repeat as needed until all feedback has been addressed.
When starting work, please make sure your clone of the originating master branch is up-to-date
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and not
your clone of the originating master branch.
Lastly, published copies of all the lessons are available in the master branch of the originating
repository for reference while revising.