Add guidance on how to write good commit messages when using Git.
Why are these changes being made?
It's a question we regularly get from new starters, plus I wanted a place to stash a link to the Git commit convention site too for future reference.
Detailed description of changes
Have moved the commits section above the branches section under 'Tips for using Git' as it felt like a more logical starting place (though up for debate!)
Added generic advice on committing regularly (another frequent question we get)
Moved the existing commit guidance into a specific 'In RStudio section'
Added details on how to write good commit messages and a link to the commit conventions site
Screenshot of a local build showing the formatting of the new guidance:
Overview of changes
Add guidance on how to write good commit messages when using Git.
Why are these changes being made?
It's a question we regularly get from new starters, plus I wanted a place to stash a link to the Git commit convention site too for future reference.
Detailed description of changes
Screenshot of a local build showing the formatting of the new guidance:
Issue ticket number/s and link
N/A - though there is a Trello card on our SDT board that Tess had added some notes to.
Checklist before requesting a review