Skip to content

Github guidelines

The material in this folder documents the Nesta's Github workflow protocol.

Nesta's workflow, with the pages in these guidelines highlighted in blue.

In brief, all code we write should be version controlled using Git and managed on Github according to our Git workflow.

Furthermore, we encourage you to manage the development process in Github, to maximise visibility, making it easy for everyone involved to understand what's going on.

  • Rationale - why does this protocol exist?
  • Training - where to go to get up to speed with git(hub)
  • Setup - how to setup git to work with the Nesta Github.
  • Repositories - what a repository is and how to start working on one.
  • Branches - how to manage branches
  • Git workflow - a walk through our git workflow
  • Creating a PR - collaboration through pull requests: creating a pull request and what to add to the PR summary
  • Reviewing a PR - collaboration through code reviews: how to review a pull request
  • Project management - using git projects management
  • Hints - assorted useful hints
  • Licensing - in brief: use MIT
  • Linking - how to refer to content in Github