Project template

Find helpful templates for your Git project here, ready for you to make your own! Customise to suit your project’s unique needs.

The template files include:

File

Description

README.md

A draft README file, that follows the suggestions for a good README.

LICENSE

Provides license information and is referenced from the README file. Please note that the LICENSE file has no .md extension. In this example, the MIT licence was used.

CONTRIBUTING.md

Provides details of how to contribute.

CHANGELOG.md

Provides details about changes.

CITATION.cff

You can add a CITATION.cff file to the root of a repository to let others know how you would like them to cite your work (GitHub only!). See the CITATION.cff documentation for more details about the Citation File Format.

.gitignore

If you’re using Git, this file provides details on what you don’t want to be committed to the repository. A collection of usefull .gitignore templates can be found here.