GitHub template for FAIR and open research data

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.

GitHub issues GitHub forks GitHub stars Code license Data license

Why use a template (even for small datasets)?

How this template helps you

Open research data

Documentation

Consistency

Security

Ethics

Installation

To initialize the template, generate a new project, clone the repository to your local machine and follow this guide.

  1. Install Node.js and run the following commands in the root directory of the repository:
npm install
npm run prepare
  1. Complete the following checklist of tasks to customize the template for your project:
  1. optional tasks:

Use

Check 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

Support

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

Roadmap

There are currently no changes planned.

Contributing

Please see CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Authors and credits

  • Moritz Mรคhr - Initial work - maehr

See also the list of contributors who contributed to this project.

License

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.

Back to top