This GitHub template is independent of the (research) data and its format. It follows the best practices for open research data as outlined in The Turing Way. It uses GitHub Actions to manage releases, issues, and pull requests, GitHub Pages for documentation, and Zenodo for long-term archiving.
To initialize the template, generate a new project, clone the repository to your local machine and follow this guide.
npm install
npm run prepare
FULLNAME
, USERNAME
, REPO_NAME
, SHORT_DESCRIPTION
[INSERT CONTACT METHOD]
in CODE_OF_CONDUCT.md, package.json, README.template.md, SECURITY.mdZENODO_RECORD
to README.md./
, e.g. via favicon.ioTODO
in the project (mostly documentation) and fix itnpm run format
to format all filesnpm run commit
to commit all changesnpm run changelog
and include the output in CHANGELOG.mdquarto publish gh-pages
to publish the documentationgh-pages
branchCITATION.CFF
according to citation-file-format.github.io.zenodo.json
according to zenodo.orgCheck that all files are properly formatted.
npm run check
Format all files.
npm run format
Run the wizard to write meaningful commit messages.
npm run commit
Run the wizard to create a CHANGELOG.md.
npm run changelog
Preview the documentation.
quarto preview
This project is maintained by @maehr. Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.
Type | Platforms |
---|---|
🚨 Bug Reports | GitHub Issue Tracker |
📊 Report bad data | GitHub Issue Tracker |
📚 Docs Issue | GitHub Issue Tracker |
🎁 Feature Requests | GitHub Issue Tracker |
🛡 Report a security vulnerability | See SECURITY.md |
💬 General Questions | GitHub Discussions |
There are currently no changes planned.
Please see CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
See also the list of contributors who contributed to this project.
The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the LICENSE-CCBY file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.
The code in this repository is released under the GNU Affero General Public License v3.0 - see the LICENSE-AGPL file for details. By using this code, you agree to make any modifications available under the same license.