You should use the teki-lidi template when creating your repositories.
- Naming: kebab-cased (lowercase, words separated with hyphens)
- Readme with at least:
- A short description of what the repository does
- How to install
- How to use
- License and Visibility:
- Private: No license should be used. Why?
- Public: Check with your Tech Lead first.
E.g. feat(context/sub-context): title of pull request
type/kebab-cased-name
E.g. feat/changing-wall-color
E.g. feat: this is my cool commit
feat add a new feature.
fix fix a bug.
refactor rewrite/restructure your code, however does not change any behaviour.
test add missing tests or correcting existing tests.
docs affect documentation only.
chore miscellaneous commits e.g. modifying .gitignore
build changes that affect build tools like, webpack, vite, NPM scripts...
ci affect pipeline files, like Github actions workflow.
E.g. feat(home): cleaning up my house
The scope provides contextual information.
- Is an optional part of the format
- Allowed Scopes depends on the specific project
E.g. fix(home/living-room): add chair lag
- Create a repository template
- Badges implementation
- Contributing section