I Made Conventional Commits for Research! Please Review it! #194226
Closed
willdone-mt
started this conversation in
Discover: GitHub Best Practices
Replies: 1 comment
-
|
Thank you for your interest in contributing to our community! We currently only accept discussions created through the GitHub UI using our provided discussion templates. Please re-submit your discussion by navigating to the appropriate category and using the template provided. This discussion has been closed because it was not submitted through the expected format. If you believe this was a mistake, please reach out to the maintainers. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
After starting a research project on git, i think the commits also need to be neat and tidy like other software projects.
I could not find any research project GitHub repository to take example from [If there one, please let me know].
Because the existing Conventional Commits specification was designed specifically for software projects,
its popular types often fail to capture the unique nuances of scientific research.
Therefore, i made a Conventional Commits adaptation for research project
The Conventional Commits for Research specification is a mediumweight convention on top of commit messages,
specialized for research project stored in version control repositories.
It provides an easy set of rules for creating an explicit commit history;
which makes it easier to write automated tools on top of.
This convention adapted from already existing Conventional Commits,
[currently doesnt have any versioning to be dovetailed with].
The full document are written here https://gist.github.com/willdone-mt/fdbad17dc66d90b54552b4e5b82a4f2e
Please share your review, suggestion, and thought in this discussion! here!
THANK YOU VERY MUCH!
Beta Was this translation helpful? Give feedback.
All reactions