From bfaeecef735b2c287ac3c15691851082bb24bdde Mon Sep 17 00:00:00 2001 From: "Eshan Roy (Eshanized)" Date: Thu, 2 May 2024 21:46:52 +0530 Subject: [PATCH] docs: add more specific documentation on commit message --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a49e1f1..f3333a2 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@

SNIGDHA OS WELCOME

+ +>You must follow the commit types with commitizen. + +## Commit types + +| Commit Type | Title | Description | Emoji | +| ----------- | ------------------------ | ----------------------------------------------------------------------------------------------------------- |:------:| +| `feat` | Features | A new feature | ✨ | +| `fix` | Bug Fixes | A bug Fix | 🐛 | +| `docs` | Documentation | Documentation only changes | 📚 | +| `style` | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 | +| `refactor` | Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 | +| `perf` | Performance Improvements | A code change that improves performance | 🚀 | +| `test` | Tests | Adding missing tests or correcting existing tests | 🚨 | +| `build` | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 | +| `ci` | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ | +| `chore` | Chores | Other changes that don't modify src or test files | ♻️ | +| `revert` | Reverts | Reverts a previous commit | 🗑 |