Skip to content

Commit 588a232

Browse files
docs: add commit and pull request convention guidelines
added Conventional Commits guidelines documented recommended pull request title format added branch naming examples documented common commit types and usage examples improved contributor workflow documentation
2 parents ca824d5 + a35ba61 commit 588a232

1 file changed

Lines changed: 49 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Thank you for your interest in contributing to DebugProbe.AspNetCore.
55
## Getting Started
66

77
Clone the repository and open the solution:
8-
8+
co
99
```bash
1010
git clone https://github.com/georgidhristov/DebugProbe.AspNetCore.git
1111
```
@@ -30,23 +30,69 @@ Run the sample API project to test DebugProbe functionality and UI behavior duri
3030

3131
## Branch Naming
3232

33-
Use descriptive lowercase branch names:
33+
Use descriptive lowercase branch names.
3434

35-
Example:
35+
Examples:
3636

3737
```text
3838
feature/add-request-filtering
39+
fix/handle-empty-response-body
40+
refactor/split-compare-engine
41+
ci/update-github-actions
42+
docs/update-contributing-guide
43+
```
44+
45+
## Commit Message Convention
46+
47+
This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
48+
49+
Format:
50+
51+
```text
52+
type: short description
53+
```
54+
55+
Examples:
56+
57+
```text
58+
feat: add payload type badges
59+
fix: handle empty compare bodies
60+
refactor: split compare engine
61+
docs: update README screenshots
62+
ci: run automated tests in GitHub Actions
63+
test: add request persistence tests
3964
```
4065

66+
Common commit types:
67+
68+
- `feat` → new feature
69+
- `fix` → bug fix
70+
- `refactor` → internal code restructuring
71+
- `docs` → documentation changes
72+
- `test` → automated tests
73+
- `ci` → CI/CD and GitHub Actions
74+
- `chore` → maintenance and tooling updates
75+
4176
## Pull Requests
4277

4378
Before opening a pull request:
4479

4580
- Ensure the project builds successfully
81+
- Ensure all automated tests pass
4682
- Keep pull requests focused and small
4783
- Provide a clear description of the change
4884
- Link related issues when applicable
4985

86+
Pull request titles should also follow Conventional Commits.
87+
88+
Examples:
89+
90+
```text
91+
feat: add request filtering
92+
fix: persist requests on unhandled exceptions
93+
docs: improve contributing guidelines
94+
```
95+
5096
## Coding Style
5197

5298
- Keep implementations simple and maintainable

0 commit comments

Comments
 (0)