From 9b59d82970a8fd943f9c8d27987b5aacc0d91dbb Mon Sep 17 00:00:00 2001 From: Ellet Date: Fri, 5 Jul 2024 08:06:07 +0300 Subject: [PATCH] docs(contributing): update the versioning and releases guideline --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8cde2b5..6e3112f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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