Skip to content

Commit 9d74c9f

Browse files
committed
docs(VERSION_MANAGEMENT): add commit message guidelines and format
- Include quick guide for common commit types with examples - Add section on commit message format (header, body, footer) - Provide example of breaking change commit message - Improve documentation for consistent commit practices
1 parent a86e98e commit 9d74c9f

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ assinstants/
6969

7070
## Setup and Execution Flow Diagram
7171

72-
![Setup and Execution Flow Diagram](./Images/Setup%20and%20Execution%20Flow%20Diagram.png)
72+
![Setup and Execution Flow Diagram](./assinstants/Images/Setup%20and%20Execution%20Flow%20Diagram.png)
7373

7474
## Run Execution and Tool Usage Diagram
7575

76-
![Run Execution and Tool Usage Diagram](./Images/Run%20Execution%20and%20Tool%20Usage%20Flowchart.png)
76+
![Run Execution and Tool Usage Diagram](./assinstants/Images/Run%20Execution%20and%20Tool%20Usage%20Flowchart.png)
7777

7878
## Asynchronous Operation Diagram
7979

80-
![Asynchronous Operation Diagram](./Images/Asynchronous%20Operation%20Diagram.png)
80+
![Asynchronous Operation Diagram](./assinstants/Images/Asynchronous%20Operation%20Diagram.png)
8181

8282
## Quick Start Guide
8383

VERSION_MANAGEMENT.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,38 @@ setup(
6767

6868
3. Create a PR with the release notes.
6969

70-
By following this strategy, we can maintain multiple versions, work on new features, and provide a clear upgrade path for users.
70+
## Commit Message Guidelines
71+
72+
We follow the Conventional Commits specification. Here's a quick guide for common commit types:
73+
74+
- feat: New feature
75+
Example: feat(auth): add login functionality
76+
77+
- fix: Bug fix
78+
Example: fix(api): resolve user data fetch issue
79+
80+
- docs: Documentation changes
81+
Example: docs(README): update installation instructions
82+
83+
- style: Code style changes (formatting, missing semi colons, etc)
84+
Example: style(global): convert tabs to spaces
85+
86+
- refactor: Code refactoring
87+
Example: refactor(database): optimize query performance
88+
89+
- test: Adding or modifying tests
90+
Example: test(utils): add unit tests for string helpers
91+
92+
- chore: Maintenance tasks
93+
Example: chore(deps): update dependencies
94+
95+
For breaking changes, add BREAKING CHANGE: in the commit body or footer.
96+
97+
Example:
98+
feat(api): change user authentication flow
99+
100+
BREAKING CHANGE: `loginUser` now returns a Promise instead of a callback
101+
102+
## Commit Message Format
103+
104+
Each commit message consists of a header, a body, and a footer. The header has a special format that includes a type, an optional scope, and a subject:

0 commit comments

Comments
 (0)