|
66 | 66 | - Congrats! 🥳 You've made your first pull request to this project repo.
|
67 | 67 | - Wait for your pull request to be reviewed and if required suggestions would be provided to improve it.
|
68 | 68 | - Celebrate 🥳 your success after your pull request is merged successfully.
|
| 69 | +
|
| 70 | +
|
| 71 | +## ✅ Guidelines for Good Commit Messages |
| 72 | +We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines: |
| 73 | +
|
| 74 | +1. **Be Concise and Descriptive**: Summarize the change in a way that’s easy to understand at a glance. |
| 75 | +2. **Use the Imperative Mood**: Write as if giving a command (e.g., `Add`, `Fix`, `Update`), which is a convention in many projects. |
| 76 | +3. **Include Context**: Provide context or reason for the change if it’s not immediately obvious from the summary. |
| 77 | +4. **Reference Issues and Pull Requests**: Include `issue numbers` or PR references if the commit addresses them. |
| 78 | +5. **Issue reference** (Optional): Include the issue number associated with the commit (e.g., `#123`). |
| 79 | +
|
| 80 | +## 📝 Commit Message Examples ✅ |
| 81 | +### Enhancing Documentation |
| 82 | +- `Improve - readability of <document> tutorial` |
| 83 | +- `Add - examples to ML documentation` |
| 84 | +- `Enhance - troubleshooting section in Prometheus guide` |
| 85 | +
|
| 86 | +### General Maintenance |
| 87 | +- `Refactor - README for better clarity` |
| 88 | +- `Reorganize repository structure for easier navigation` |
| 89 | +- `Remove - outdated tools from recommendations` |
| 90 | +
|
| 91 | +# ❌ Examples of Invalid Commit Messages |
| 92 | +
|
| 93 | +- `Added new stuff` |
| 94 | +- `Fixed a bug` |
| 95 | +- `Updated code` |
| 96 | +- `auth feature update` |
| 97 | +- `chore: fixed some stuff` |
| 98 | +
|
| 99 | +## Commit Example with Commitlint |
| 100 | +
|
| 101 | +```bash |
| 102 | +git commit -m "feat(auth): Implement user signup process (#789)" |
| 103 | +``` |
| 104 | +
|
| 105 | +--- |
| 106 | +
|
| 107 | +- If something is missing here, or you feel something is not well described, please [raise an issue](https://github.com/recodehive/machine-learning-repos/issues). |
| 108 | +
|
0 commit comments