# 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](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/README.md) | A draft README file, that follows the [suggestions for a good README](../best_practices/readme.md).
[LICENSE](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/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](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/CONTRIBUTING.md) | Provides details of how to contribute.
[CHANGELOG.md](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/CHANGELOG.md) | Provides details about changes.
[CITATION.cff](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/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](https://citation-file-format.github.io/) for more details about the Citation File Format.
[.gitignore](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/.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](https://github.com/github/gitignore).

:::{note}
The complete project template is available at: [https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/](https://cau-git.rz.uni-kiel.de/CRC-1261/rdm/guide/-/blob/main/examples/gitlab-project-template/)
:::