Skip to content

Commit 0c33513

Browse files
committed
Revert "docs: ✏️ Add commit guidelines & rules in contribution guide"
Reason: This section is redundant as we are not using Commitizen with git-cz This reverts commit a86486c.
1 parent 9724352 commit 0c33513

File tree

2 files changed

+2
-41
lines changed

2 files changed

+2
-41
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ git checkout -b feature/your-feature-name
191191
**Commit your changes:**
192192

193193
```bash
194-
git commit
194+
git commit -m "Add: brief description of your changes"
195195
```
196196

197197
**Push to your fork:**

community/contributing-guidelines.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,11 @@ sidebar_position: 2
77

88
## Table of Contents
99

10-
- [Table of Contents](#table-of-contents)
1110
- [Local Setup Guide](#local-setup-guide)
12-
- [How to set up recode hive:](#how-to-set-up-recode-hive)
1311
- [Environment Setup (for GitHub API access)](#environment-setup-for-github-api-access)
1412
- [Contributing to recode hive](#contributing-to-recode-hive)
15-
- [Commit Message Format](#commit-message-format)
16-
- [Example Commit Messages:](#example-commit-messages)
17-
- [Using Commitizen with Husky](#using-commitizen-with-husky)
1813
- [Formatting](#formatting)
19-
- [Branding \& Naming Conventions](#branding--naming-conventions)
20-
- [Exceptions to Lowercase Branding](#exceptions-to-lowercase-branding)
14+
- [Branding & Naming Conventions](#branding--naming-conventions)
2115
- [License](#license)
2216

2317
## Local Setup Guide
@@ -149,39 +143,6 @@ We welcome contributions! Follow these steps to get started.
149143
git add .
150144
git commit -m "Brief description of your changes"
151145
```
152-
#### Commit Message Format
153-
154-
We use [Commitizen](https://www.npmjs.com/package/commitizen) with the [git-cz](https://www.npmjs.com/package/git-cz) adapter to ensure consistent commit messages that follow a standard changelog style. This helps in generating changelogs and maintaining a clear project history.
155-
156-
Commit messages should follow this pattern:
157-
158-
```
159-
<type>: [#<GIT-ISSUE>] <subject>
160-
```
161-
- **type**: The type of change that you're committing. It should be one of the following:
162-
- **feat**: A new feature
163-
- **fix**: A bug fix
164-
- **docs**: Documentation only changes
165-
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
166-
- **refactor**: A code change that neither fixes a bug nor adds a feature
167-
- **perf**: A code change that improves performance
168-
- **test**: Adding missing tests or correcting existing tests
169-
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
170-
- **ci**: Changes to CI configuration files and scripts
171-
172-
- **GIT-ISSUE**: The Git issue ID associated with the change.
173-
- **subject**: A brief description of the change.
174-
175-
### Example Commit Messages:
176-
177-
- `feat: [#1] Add user login functionality`
178-
- `fix: [#24] Resolve navbar alignment issue`
179-
- `chore: [#101] Update dependencies to latest versions`
180-
181-
### Using Commitizen with Husky
182-
183-
We have configured [Husky](https://www.npmjs.com/package/husky) to automatically run Commitizen when you commit changes. This is done using the `prepare-commit-msg` hook. Simply use the `git commit` command, and Commitizen will guide you through the commit message creation process.
184-
185146

186147
7. **Push Your Branch to Your Fork**
187148

0 commit comments

Comments
 (0)