Skip to content

Commit

Permalink
docs(contributing): update the versioning and releases guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
Ellet committed Jul 5, 2024
1 parent de91564 commit 9b59d82
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,18 @@ discussed above
Use pull requests and code reviews to discuss proposed changes and improvements.
6. **Versioning and Releases**:

Try to follow semantic versioning for releases (https://semver.org/) when possible.
The project uses standard practices for versioning and releases:
- **Versioning**: [Semantic Versioning](https://semver.org/) which use `MAJOR.MINOR.PATCH` format to indicate
changes.
- **Commit messages**: [Conventional Commits](https://www.conventionalcommits.org/) for clear and consistent commit
messages.
- **Pull Request Titles**: [PR title using conventional commits](https://flank.github.io/flank/pr_titles/) style for
clarity and consistency.
- **Changelog**: [Keep a Changelog](https://keepachangelog.com/) to document release notes and changes.

Clearly document release notes and changes for each version.
For now, we might introduce breaking changes in non-major versions.
guide in each release info

We might introduce breaking changes even in non-major versions. We plan to avoid doing this someday.
7. **Consistency**:

Adhere to a consistent coding style throughout the project to improve readability and maintainability
Expand Down

0 comments on commit 9b59d82

Please sign in to comment.