Skip to content
Helen Burns edited this page Aug 19, 2018 · 2 revisions

Maintaining a good repository

After setting up a repository from the information on the Git page.

It is important to keep the repository in good condition.

1. README

The readme file can be written in markdown and contain the following information as a general rule

  • Description

  • Installation

  • Usage

  • Link to additional documentation such as the Wiki

  • Contribution information

  • License information

2. Commits

Udacity provides a fantastic style guide for commit messages found HERE.

This is a good habit to get into

Clone this wiki locally