Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BREAKING CHANGE: project renaming #4

Merged
merged 1 commit into from
Oct 19, 2023
Merged

BREAKING CHANGE: project renaming #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# GitHub template for FAIR and open data
# 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 data as outlined in [The Turing Way](https://the-turing-way.netlify.app/). It uses [GitHub Actions](https://docs.github.com/en/actions) to manage releases, issues, and pull requests, [GitHub Pages](https://pages.github.com/) for documentation, and [Zenodo](https://zenodo.org/) for long-term archiving.
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](https://the-turing-way.netlify.app/). It uses [GitHub Actions](https://docs.github.com/en/actions) to manage releases, issues, and pull requests, [GitHub Pages](https://pages.github.com/) for documentation, and [Zenodo](https://zenodo.org/) for long-term archiving.

[![GitHub issues](https://img.shields.io/github/issues/maehr/open-data-template.svg)](https://github.com/maehr/open-data-template/issues)
[![GitHub forks](https://img.shields.io/github/forks/maehr/open-data-template.svg)](https://github.com/maehr/open-data-template/network)
[![GitHub stars](https://img.shields.io/github/stars/maehr/open-data-template.svg)](https://github.com/maehr/open-data-template/stargazers)
[![GitHub license](https://img.shields.io/github/license/maehr/open-data-template.svg)](https://github.com/maehr/open-data-template/blob/main/LICENSE.md)
[![GitHub issues](https://img.shields.io/github/issues/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/issues)
[![GitHub forks](https://img.shields.io/github/forks/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/network)
[![GitHub stars](https://img.shields.io/github/stars/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/stargazers)
[![GitHub license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE.md)

## Why use a template (even for small datasets)?

- Share your [open data](#open-data) with others
- Share your [open research data](#open-research-data) with others
- Write better [documentation](#documentation) for yourself and the community
- Write more [consistent](#consistency) code and encourage collaboration
- Increase [security](#security)
- Follow accepted [ethics](#ethics)

## How this template helps you

### Open data
### Open research data

- Citeable via [CITATION.cff](CITATION.cff) and [DOI](https://www.doi.org/)
- Automatic long-term archiving via [Zenodo](https://zenodo.org/)
Expand Down Expand Up @@ -55,7 +55,7 @@ This GitHub template is independent of the (research) data and its format. It fo

## Installation

To initialize the template, [generate](https://github.com/maehr/open-data-template/generate) a new project, [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the repository to your local machine and follow this guide.
To initialize the template, [generate](https://github.com/maehr/open-research-data-template/generate) a new project, [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the repository to your local machine and follow this guide.

1. Install [Node.js](https://nodejs.org/en/) and run the following commands in the root directory of the repository:

Expand Down Expand Up @@ -111,14 +111,14 @@ npm run changelog

This project is maintained by [@maehr](https://github.com/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](https://github.com/maehr/open-data-template/issues) |
| 📊 **Report bad data** | [GitHub Issue Tracker](https://github.com/maehr/open-data-template/issues) |
| 📚 **Docs Issue** | [GitHub Issue Tracker](https://github.com/maehr/open-data-template/issues) |
| 🎁 **Feature Requests** | [GitHub Issue Tracker](https://github.com/maehr/open-data-template/issues) |
| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md) |
| 💬 **General Questions** | [GitHub Discussions](https://github.com/maehr/open-data-template/discussions) |
| Type | Platforms |
| -------------------------------------- | -------------------------------------------------------------------------------------- |
| 🚨 **Bug Reports** | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues) |
| 📊 **Report bad data** | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues) |
| 📚 **Docs Issue** | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues) |
| 🎁 **Feature Requests** | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues) |
| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md) |
| 💬 **General Questions** | [GitHub Discussions](https://github.com/maehr/open-research-data-template/discussions) |

## Roadmap

Expand All @@ -132,7 +132,7 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct

- **Moritz Mähr** - _Initial work_ - [maehr](https://github.com/maehr)

See also the list of [contributors](https://github.com/maehr/open-data-template/graphs/contributors) who contributed to this project.
See also the list of [contributors](https://github.com/maehr/open-research-data-template/graphs/contributors) who contributed to this project.

## License

Expand Down
14 changes: 7 additions & 7 deletions README.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ curl -i https://zenodo.org/api/records/ZENODO_RECORD

This project is maintained by [@USERNAME](https://github.com/USERNAME). 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](https://github.com/USERNAME/REPO_NAME/issues) |
| 📊 **Report bad data** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 📚 **Docs Issue** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 🎁 **Feature Requests** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| Type | Platforms |
| -------------------------------------- | ----------------------------------------------------------------------- |
| 🚨 **Bug Reports** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 📊 **Report bad data** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 📚 **Docs Issue** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 🎁 **Feature Requests** | [GitHub Issue Tracker](https://github.com/USERNAME/REPO_NAME/issues) |
| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md) |
| 💬 **General Questions** | [GitHub Discussions](https://github.com/USERNAME/REPO_NAME/discussions) |
| 💬 **General Questions** | [GitHub Discussions](https://github.com/USERNAME/REPO_NAME/discussions) |

## Roadmap

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"commitizen": "^4.3.0",
"cz": "^1.8.2",
"cz-conventional-changelog": "^3.3.0",
"git-cliff": "^1.2.0",
"git-cliff": "^1.3.1",
"husky": "^8.0.3",
"prettier": "^2.8.8"
"prettier": "^3.0.3"
},
"type": "module",
"config": {
Expand Down
Loading