Skip to content

Commit 0677b3a

Browse files
Copilot04shubham7
andcommitted
docs: remove commitlint references from README per maintainer request
Co-authored-by: 04shubham7 <[email protected]>
1 parent ec254b6 commit 0677b3a

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -145,23 +145,15 @@ UniLoot/
145145

146146
### Development
147147

148-
This project uses conventional commits. Make sure your commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
148+
Make sure your commit messages are clear and descriptive.
149149

150150
```bash
151151
# Example commit messages
152-
git commit -m "feat: add user authentication"
153-
git commit -m "fix: resolve payment gateway issue"
154-
git commit -m "docs: update README with setup instructions"
152+
git commit -m "Add user authentication feature"
153+
git commit -m "Fix payment gateway issue"
154+
git commit -m "Update README with setup instructions"
155155
```
156156

157-
### Commit Message Validation
158-
159-
#### 🔍 Commitlint (Local Git Hooks)
160-
- **Validates** all commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) format
161-
- **Runs on**: Every commit (via Husky git hooks)
162-
- **Required format**: `type(scope): description`
163-
- **Common types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
164-
165157
### GitHub Actions Workflows
166158

167159
#### 🏷️ Label Checker
@@ -186,13 +178,13 @@ Please read our [Contributing Guide](.github/Contributor_Guide/Contributing.md)
186178

187179
1. Fork the repository
188180
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
189-
3. Commit your changes following [conventional commits](.github/Contributor_Guide/commiting.md)
181+
3. Commit your changes with clear and descriptive commit messages
190182
4. Push to the branch (`git push origin feature/AmazingFeature`)
191183
5. Open a Pull Request
192184

193185
Make sure to:
194186
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md)
195-
- Write clear commit messages following the conventional commits format
187+
- Write clear and descriptive commit messages
196188
- Add appropriate labels to your PR (Type, Semver, and PR:Accept)
197189
- Ensure all GitHub Actions checks pass
198190
- Update documentation as needed

0 commit comments

Comments
 (0)