972 B
972 B
Contributing
1. Default Branch Name
Use master
as root branch name.
2. Initial Commit
Initialize repository and it's first commit without any content included:
git commit --allow-empty -m "init"
3. Conventional Commits
Use the Conventional Commits specification for commit messages. Examples:
feat(cli): add a new cli feature
fix(parser): resolve a bug
docs: update documentation
chore: general maintenance or tooling changes
Clear commit messages make the history easier to read and improve collaboration.
Additionaly, consider making more smaller commits than one bigger.
4. Semantic Versioning
Adhere to Semantic Versioning (SemVer) for project versioning:
MAJOR
: Breaking changesMINOR
: New features, backward compatiblePATCH
: Bug fixes, backward compatible
Proper versioning ensures users and contributors understand the impact of updates.