diff --git a/docs/git/goodgit.md b/docs/git/goodgit.md index 232569b..43d73fd 100644 --- a/docs/git/goodgit.md +++ b/docs/git/goodgit.md @@ -9,33 +9,33 @@ If you work alone with your own private repository, those tips are not necessary They are for the final code that will come with your MSc thesis. ## General -- [ ] the repository should be publicly available +- [ ] The repository should be publicly available ## Documentation -- [ ] there should be a README file that indicates +- [ ] There should be a README file that indicates - - the purpose of the project, what the code is for, - - installation instructions - - example usage + - The purpose of the project, what the code is for, + - Installation instructions + - Example usage - API documentation (if this applies) -- [ ] the README should be a text file (`readme.md` or `readme.txt`), and not a binary file like Word -- [ ] there should be a [LICENSE file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository). ([Help with choosing a license](https://choosealicense.com)) -- [ ] there should be a [CITATION file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) that tells users how to site the project, data, and code -- [ ] a `changelog.md` detailing the changes between the releases should be available ([help with changelog](https://keepachangelog.com/en/)) -- [ ] there should be clear guidelines for third-parties wishing to: (1) contribute to the software; (2) report issues or problems with the software; (3) seek support +- [ ] The README should be a text file (`readme.md` or `readme.txt`), and not a binary file like Word +- [ ] There should be a [LICENSE file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository). ([Help with choosing a license](https://choosealicense.com)) +- [ ] There should be a [CITATION file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) that tells users how to site the project, data, and code +- [ ] A `changelog.md` detailing the changes between the releases should be available ([help with changelog](https://keepachangelog.com/en/)) +- [ ] There should be clear guidelines for third-parties wishing to: (1) contribute to the software; (2) report issues or problems with the software; (3) seek support ## Organization -- [ ] folders should be used to separate data, code, documentation, and results +- [ ] Folders should be used to separate data, code, documentation, and results - - it is the custom to put all source code in `/src` - - and `/test` for unit tests - - but each language will have different setups and habits -- [ ] the files should use a consistent naming scheme that indicates what they contain + - It is the custom to put all source code in `/src` + - And `/test` for unit tests + - But each language will have different setups and habits +- [ ] The files should use a consistent naming scheme that indicates what they contain ## Files that should **not** be added to the repository @@ -55,21 +55,21 @@ Examples of files to ignore: ## Software -- [ ] there should be releases to package the software ([how to create a release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)) -- [ ] is a container available to run the proiect (eg [Docker](https://www.docker.com/))? -- [ ] are unit tests available for the code? +- [ ] There should be releases to package the software ([how to create a release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)) +- [ ] Is a container available to run the proiect (eg [Docker](https://www.docker.com/))? +- [ ] Are unit tests available for the code? ## Data -- [ ] if you project has data: are they included or a link is provided? -- [ ] ff data is not included, is this because it is not necessary or generated as part of the project? -- [ ] are your raw data (if any) and processed data files separated? +- [ ] If you project has data: are they included or a link is provided? +- [ ] If data is not included, is this because it is not necessary or generated as part of the project? +- [ ] Are your raw data (if any) and processed data files separated? ## Others -- [ ] the code should be well documented +- [ ] The code should be well documented - [ ] Does the repository make use of continuous integration tools to insure internal reproduciblity?