Listed here are the standards that are used for the EyeTrackVR project. These standards are used to ensure that the project is consistent and easy to understand.
It is by design that we use a static-site framework for the documentation site. This is to ensure that the documentation is easy to maintain and extend. This is also to ensure that the documentation is easy to understand.
We have only a few rules for the documentation site:
- All code should be written in English.
- All code should be written in a way that is easy to understand.
- All code should be written in a way that is easy to maintain.
- All code should be written in a way that is easy to extend.
- Our git commit style is to be followed, in english only.
Git Commit Style
We use the Conventional Commits standard for our git commit style. This is to ensure that our git commits are easy to understand and easy to maintain. This is also to ensure that our git commits are easy to extend.
Git commits are used to with the Semantic Release tool to automatically generate the changelog and versioning for the project. As such, it is important that we follow the Conventional Commits standard, with our own rule customizations.
The following is a list of the customizations that we have made to the Conventional Commits standard:
- We use the
BREAKINGtext to indicate a breaking change.
Our git commit style is as follows:
<type>[optional scope]: <description> [optional body] [optional footer(s)]
The following is a list of the types that we use:
feat: A new feature.
fix: A bug fix.
docs: Documentation only changes.
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
refactor: A code change that neither fixes a bug nor adds a feature.
perf: A code change that improves performance.
test: Adding missing or correcting existing tests.
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm, yarn, actions).
ci: Changes to our CI configuration files and scripts (example scopes: GH-Actions, yml, YAML).
chore: Other changes that don't modify src or test files.
revert: Reverts a previous commit.
BREAKING CHANGE: Indicate a breaking change.
no-release: This commit will not trigger a release.
An example of our git commit style is as follows:
feat: add a new feature # this is the commit title - added new thing # some detail about the new thing BREAKING CHANGE: this is a breaking change #this line is optionaland only used if needed