Protect the main branch, require pull requests

[tompollard]

As we'll be collaborating on the repository, it will be easiest to work with pull requests to the main branch. I would suggest protecting the main branch from direct commits. You can add a rule for this at: https://github.com/fredrikWHaug/consort-diagram/settings/branches

We can talk through the process of using git for development if it is helpful. Brief outline below!

Setup

• Install a code editor if you don't have one. VS Code is good: https://code.visualstudio.com/
• I would recommend installing liquidprompt, which gives you a nicer command line prompt (e.g. by displaying your current git branch). On a Mac, open Terminal and then use Homebrew: brew install liquidprompt. Follow the instructions to add liquidprompt to your bash/zsh shell.
• If you haven't set up an SSH key and added it to GitHub, you should do this. It avoids the need to keep typing your password:
  • https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
• Copy the repo to your machine. I have created a projects folder to store all of my different projects. Inside this, I run:
  • git clone [email protected]:fredrikWHaug/consort-diagram.git.

To work on a new feature, bug fix, etc:

1. make sure your main branch is up to date: git pull
2. check out your feature branch and switch to it: git switch -c fh/mynewfeature
3. make your improvements.

• keep tabs on what changes you have made with git status.
• add the changes with: git add FILENAME.
• commit the changes with: git commit -m "my commit message".
• git log will show you your commit log.

5. When the changes are ready, push them with git push (you'll receive a message saying the branch doesn't yet exist on the remote server. Just follow the instructions to create the remote branch).
6. Go to https://github.com/fredrikWHaug/consort-diagram/pulls and open your pull request.
   • Tips on a good pull request: https://blog.ploeh.dk/2015/01/15/10-tips-for-better-pull-requests/