Skip to content

Add data versioning standards to README [no version bump] #587

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

Merged
gmyenni merged 1 commit into from
Nov 18, 2025
Merged

Add data versioning standards to README [no version bump] #587

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
14 changes: 13 additions & 1 deletion .githooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
# Git Hooks

Hooks in this directory check your commit message, and enforce standards.
Hooks in this directory check your commit message, and enforce versioning standards.

To use these hooks in your local workflow, run:

`git config core.hooksPath .githooks/hooks`

Read more about [customizing git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)

## Data versioning standards

If your commit does not have versioning instructions, you will get an error and the message:
`"Aborting commit. Your commit message is missing versioning instructions.
Please add [no version bump], [patch], [minor], or [major] to your commit message"`

### Guide to using the version tags:
`[no version bump]` - Code changes that are not accompanied by data or file structure changes
`[patch]` - Minor data corrections, or more significant code changes
`[minor]` - Data additions or changes (the most commonly used tag)
`[major]` - File structure or data shape changes, addition of new data types