You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This helps automatically determine version numbers and generate changelogs.
4
+
5
+
## Format
6
+
7
+
```
8
+
<type>(<scope>): <description>
9
+
10
+
[optional body]
11
+
12
+
[optional footer(s)]
13
+
```
14
+
15
+
### Types
16
+
17
+
-`feat!:` or `fix!:` - Breaking change (triggers major version bump)
18
+
-`feat:` - A new feature (triggers minor version bump)
19
+
-`fix:` - A bug fix (triggers patch version bump)
20
+
-`docs:` - Documentation only changes
21
+
-`style:` - Changes that do not affect the meaning of the code
22
+
-`refactor:` - A code change that neither fixes a bug nor adds a feature
23
+
-`perf:` - A code change that improves performance
24
+
-`test:` - Adding missing tests or correcting existing tests
25
+
-`chore:` - Changes to the build process or auxiliary tools
26
+
27
+
### Examples
28
+
29
+
```
30
+
feat(api): add new endpoint for user authentication
31
+
32
+
This new endpoint allows users to authenticate using OAuth2.
33
+
34
+
BREAKING CHANGE: `auth` endpoint now requires OAuth2 token
35
+
```
36
+
37
+
```
38
+
fix(database): resolve connection timeout issue
39
+
40
+
Increased connection timeout from 5s to 15s
41
+
```
42
+
43
+
```
44
+
docs: update README with new API documentation
45
+
```
46
+
47
+
## Changelog Generation
48
+
49
+
Commit messages are used to:
50
+
1. Automatically determine the next version number
51
+
2. Generate changelog entries
52
+
3. Create GitHub releases
53
+
54
+
The process is automated through GitHub Actions and uses changesets for release management.
Copy file name to clipboardExpand all lines: README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,6 +124,26 @@ These examples showcase MyCoder's ability to handle complex software development
124
124
125
125
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for our development workflow, coding guidelines, and testing procedures.
126
126
127
+
## Development Workflow
128
+
129
+
### Commit Messages
130
+
131
+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for commit messages. See [COMMIT_CONVENTION.md](COMMIT_CONVENTION.md) for detailed guidelines.
132
+
133
+
### CI/CD Pipeline
134
+
135
+
The project uses GitHub Actions for continuous integration and deployment:
136
+
137
+
-**Non-main branches**: Automatically builds and tests the code
138
+
-**Main branch**: Automatically creates releases and publishes to npm
139
+
140
+
The release process is managed using [changesets](https://github.com/changesets/changesets) which:
141
+
1. Determines version bumps based on commit messages
0 commit comments