I made a Conventional Commits for Research! Please Review it!

[willdone-mt]

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

Summary

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].
This summary section is assuming the reader already familiar with Conventional Commits.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit contains the same structural elements as Conventional Commits,
with addition and changes in types, scopes, and breaking change listed below.
This was made to record changes in research process:

1. Universal commit types

   • feat: same as Conventional Commits; also used in research commits for newly acquired raw data.
   • fix: same as Conventional Commits; data can also have bugs and fixes.
   • style: same as formerly Angular Convention's.
   • docs: same as Angular Convention's; used in research commits only for project management (non-scientific) documents.
   • chore: same as formerly Angular Convention's.
   • ci: same as Angular Convention's.
   • revert: same as Conventional Commits.

2. Commit types only for changes in research

   • process: for data processing.
   • analsynt: for data discussing/analyzing/synthesizing.
   • dissem: dissemination documents.
   • method: materials and methods protocols/documents.
   • expt: not-as-a-research experiments, tests, validation, and verification of data and methods.
   • research: to group research-only type if the project is code-focused.

3. Commit types only for changes in code [used in research]

   • code: to group type feat, fix, refactor, perf, and style. These grouped types can have their own commit.
   • devtool: to group type build and test. These grouped types can have their own commit.

4. Scope. Even though scope field is optional, there are few recommended predefined scope that can be used

   • for commit type feat and fix, scope data is to represent the new or fixed data.
   • for commit type process, its scope should represent the stage/list of data processing
   • for commit type dissem, its scope should represent the types of dissemination, or part/chapter of the manuscript
   • for commit type method, its scope should represent the stage/list of method being used

5. Breaking changes

   [!NOTE]
   The definition of BREAKING-CHANGE for research commit still misty and vague.

   In research, a BREAKING CHANGE is any modification to data processing, methods, or analysis workflow/procedure
   that invalidates prior results.

NOTICE

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!

[github-actions[bot]]

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.

[willdone-mt]

Can you link me to this GitHub UI?