From 38d42ceaf4c535c17a3a8cccf488ad88b5d4b50f Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 2 May 2023 10:46:40 +0100 Subject: [PATCH 1/4] Fix README to correspond to actual cookiecutter fields. --- cookiecutter.json | 2 + {{cookiecutter.project_slug}}/README.md | 102 ++++++++++++++++++++++++ 2 files changed, 104 insertions(+) diff --git a/cookiecutter.json b/cookiecutter.json index 76e45733..809b3406 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -5,7 +5,9 @@ "project_name": "Python Template", "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-').replace('_', '-') }}", "project_short_description": "A cookieninja template with ARC recommendations.", + "funder": "JBFC: The Joe Bloggs Funding Council", "version": "0.1.0", + "license": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"], "min_python_version": ["3.8", "3.9", "3.10", "3.11"], "max_python_version": ["3.11", "3.10", "3.9", "3.8"] } diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 9314f9f9..2226ee00 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -1,3 +1,105 @@ # {{ cookiecutter.project_name }} [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) +[![Actions Status][actions-badge]][actions-link] +[![Documentation Status][rtd-badge]][rtd-link] + +[![PyPI version][pypi-version]][pypi-link] +[![Conda-Forge][conda-badge]][conda-link] +[![PyPI platforms][pypi-platforms]][pypi-link] + +[![GitHub Discussion][github-discussions-badge]][github-discussions-link] +[![Gitter][gitter-badge]][gitter-link] + + +[actions-badge]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/workflows/CI/badge.svg +[actions-link]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/actions +[conda-badge]: https://img.shields.io/conda/vn/conda-forge/{{cookiecutter.project_slug}} +[conda-link]: https://github.com/conda-forge/{{cookiecutter.project_slug}}-feedstock +[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github +[github-discussions-link]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/discussions +[gitter-badge]: https://badges.gitter.im/{{cookiecutter.project_slug}}/community.svg +[gitter-link]: https://gitter.im/{{cookiecutter.project_slug}}/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge +[pypi-link]: https://pypi.org/project/{{cookiecutter.project_slug}}/ +[pypi-platforms]: https://img.shields.io/pypi/pyversions/{{cookiecutter.project_slug}} +[pypi-version]: https://img.shields.io/pypi/v/{{cookiecutter.project_slug}} +[rtd-badge]: https://readthedocs.org/projects/{{cookiecutter.project_name}}/badge/?version=latest +[rtd-link]: https://{{cookiecutter.project_slug}}.readthedocs.io/en/latest/?badge=latest + + + +{{cookiecutter.project_short_description}} + +This project is developed in collaboration with the [Centre for Advanced Research Computing](https://ucl.ac.uk/arc), University College London. + +## About + +### Project Team + +{{cookiecutter.full_name}} ([{{cookiecutter.email}}](mailto:{{cookiecutter.email}})) + + + +### Research Software Engineering Contact + +Centre for Advanced Research Computing, University College London +([arc-collab@ucl.ac.uk](mailto:arc-collab@ucl.ac.uk)) + +## Built With + + + +[Framework 1](https://something.com) +[Framework 2](https://something.com) +[Framework 3](https://something.com) + +## Getting Started + +### Prerequisites + +Any tools or versions of languages needed to run code. For example specific Python or Node versions. Minimum hardware requirements also go here. + +### Installation + +How to build or install the application. + +### Running Locally + +How to run the application on your local system. + +### Running Tests + +How to run tests on your local system. + +## Roadmap + +- [x] Initial Research +- [ ] Minimum viable product <-- You are Here +- [ ] Alpha Release +- [ ] Feature-Complete Release + +## License + +Distributed under the terms of the `{{cookiecutter.license}}`\_ license. + +## Citation + +Please cite [xx.yyy/zenodo.zzzz](https://doi.org/xx.yyy/zenodo.zzzzz) for this work if you use this code. + +
+BibTEX + +```bibtex +@article{xxx2023paper, + title={Title}, + author={Author}, + journal={arXiv}, + year={2023} +} +``` + +
+ +## Acknowledgements + +This work was funded by a grant from the {{ cookiecutter.funder }}. From 1aa9a4df8410b409fa05dd3bf3a8d926b0dd12c5 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 14 Mar 2023 11:37:16 +0000 Subject: [PATCH 2/4] A skeleton CITATION.cff --- {{cookiecutter.project_slug}}/CITATION.cff | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 {{cookiecutter.project_slug}}/CITATION.cff diff --git a/{{cookiecutter.project_slug}}/CITATION.cff b/{{cookiecutter.project_slug}}/CITATION.cff new file mode 100644 index 00000000..fdf0281a --- /dev/null +++ b/{{cookiecutter.project_slug}}/CITATION.cff @@ -0,0 +1,8 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: {{cookiecutter.surname}} + given-names: {{cookiecutter.first_name}} + orcid: https://orcid.org/1234-5678-9101-1121 +title: {{cookiecutter.project_name}} +doi: xx.yyy/zenodo.zzz From dae8fb199979f48df312b84f4eb3709c7e3ddee4 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 14 Mar 2023 12:12:41 +0000 Subject: [PATCH 3/4] Make the linters happy. --- {{cookiecutter.project_slug}}/CITATION.cff | 6 +++--- {{cookiecutter.project_slug}}/README.md | 4 ++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.project_slug}}/CITATION.cff b/{{cookiecutter.project_slug}}/CITATION.cff index fdf0281a..7eddcf16 100644 --- a/{{cookiecutter.project_slug}}/CITATION.cff +++ b/{{cookiecutter.project_slug}}/CITATION.cff @@ -1,8 +1,8 @@ cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - - family-names: {{cookiecutter.surname}} - given-names: {{cookiecutter.first_name}} + - family-names: { { cookiecutter.surname } } + given-names: { { cookiecutter.first_name } } orcid: https://orcid.org/1234-5678-9101-1121 -title: {{cookiecutter.project_name}} +title: { { cookiecutter.project_name } } doi: xx.yyy/zenodo.zzz diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 2226ee00..9bef6faa 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -73,6 +73,10 @@ How to run tests on your local system. ## Roadmap +- [x] Initial Research +- [ ] Minimum viable product <-- You are Here +- [ ] Alpha Release +- [ ] Feature-Complete Release - [x] Initial Research - [ ] Minimum viable product <-- You are Here - [ ] Alpha Release From 6b7d6a42db202259a4661bb9523dc698d2e0cabd Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 2 May 2023 11:35:55 +0100 Subject: [PATCH 4/4] Apply suggestions from code review --- cookiecutter.json | 2 +- {{cookiecutter.project_slug}}/README.md | 16 ++++------------ 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/cookiecutter.json b/cookiecutter.json index 809b3406..9cfc634f 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -7,7 +7,7 @@ "project_short_description": "A cookieninja template with ARC recommendations.", "funder": "JBFC: The Joe Bloggs Funding Council", "version": "0.1.0", - "license": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"], + "licence": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"], "min_python_version": ["3.8", "3.9", "3.10", "3.11"], "max_python_version": ["3.11", "3.10", "3.9", "3.8"] } diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 9bef6faa..4a4a1994 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -2,29 +2,21 @@ [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Actions Status][actions-badge]][actions-link] -[![Documentation Status][rtd-badge]][rtd-link] + [actions-badge]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/workflows/CI/badge.svg [actions-link]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/actions [conda-badge]: https://img.shields.io/conda/vn/conda-forge/{{cookiecutter.project_slug}} [conda-link]: https://github.com/conda-forge/{{cookiecutter.project_slug}}-feedstock -[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github -[github-discussions-link]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/discussions -[gitter-badge]: https://badges.gitter.im/{{cookiecutter.project_slug}}/community.svg -[gitter-link]: https://gitter.im/{{cookiecutter.project_slug}}/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge [pypi-link]: https://pypi.org/project/{{cookiecutter.project_slug}}/ [pypi-platforms]: https://img.shields.io/pypi/pyversions/{{cookiecutter.project_slug}} [pypi-version]: https://img.shields.io/pypi/v/{{cookiecutter.project_slug}} -[rtd-badge]: https://readthedocs.org/projects/{{cookiecutter.project_name}}/badge/?version=latest -[rtd-link]: https://{{cookiecutter.project_slug}}.readthedocs.io/en/latest/?badge=latest @@ -82,9 +74,9 @@ How to run tests on your local system. - [ ] Alpha Release - [ ] Feature-Complete Release -## License +## Licence -Distributed under the terms of the `{{cookiecutter.license}}`\_ license. +Distributed under the terms of the `{{cookiecutter.licence}}`\_ licence. ## Citation