How to contribute to cambridge-ceu

Assuming you have registered a GitHub account, simply contact owner of a repository to add yourself as a contributor.

As adapted from Apress, a more general approach involves the following steps:

  1. Make sure you have a GitHub account.
  2. Fork a repository.
  3. Create a new branch on which to make your change, e.g. git checkout -b your_initials_or_description
  4. Commit your change. Include a commit message describing the correction. Please note that if your commit message is not clear, the correction will not be accepted.
  5. Submit a pull request from your_initials_or_description.

An example is given in NOTES.md. More generally, it would be similar to these instructions to GDAL.

Technical guides and enhancements

CAUTION -- there are issues under cardio on GitHub synchronisation so it is appropriate to use git pull but not git push which can replace files on the server with empty ones for no reasons. Sometimes it is necessary to disable the pop-up window as described in NOTES.md.

Policies

This is in line with or somewhat mirrors University's policies for HPC.

References

Blischak JD, Davenport ER, Wilson G. A Quick Introduction to Version Control with Git and GitHub. PLoS Comput Biol 2016, https://doi.org/10.1371/journal.pcbi.1004668.

Chacon S, Straub B. Pro Git, 2e. Apress, 2014, https://link.springer.com/book/10.1007%2F978-1-4842-0076-6.

GitHub education at the university https://help.uis.cam.ac.uk/news/github-education.