Skip to content

Commit b04e083

Browse files
committed
chore: Update CONTRIBUTING.md
Signed-off-by: Caijinglong <cjl_spy@163.com>
1 parent 5dea4a2 commit b04e083

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,76 @@ Edit the `Pods/Development Pods/image_editor_common/**.m` files.
4444

4545
Open `flutter_image_editor/image_editor/example/ohos` in DevEco Studio.
4646

47+
## CHANGELOG
48+
49+
When contributing to this project, please follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for your commit messages. This helps us automatically generate the CHANGELOG.
50+
51+
### Commit Message Format
52+
53+
Each commit message should be structured as follows:
54+
55+
```log
56+
<type>[optional scope]: <description>
57+
58+
[optional body]
59+
60+
[optional footer(s)]
61+
```
62+
63+
### Types
64+
65+
- `feat`: A new feature (correlates with MINOR version)
66+
- `fix`: A bug fix (correlates with PATCH version)
67+
- `docs`: Documentation only changes
68+
- `style`: Changes that do not affect the meaning of the code
69+
- `refactor`: A code change that neither fixes a bug nor adds a feature
70+
- `perf`: A code change that improves performance
71+
- `test`: Adding missing tests or correcting existing tests
72+
- `chore`: Changes to the build process or auxiliary tools
73+
74+
### Breaking Changes
75+
76+
- Add `!` after the type/scope: `feat!: breaking change`
77+
- Or add `BREAKING CHANGE:` in the footer
78+
79+
### Examples
80+
81+
```log
82+
feat(android): add image rotation support
83+
84+
fix(ios): resolve memory leak in image processing
85+
86+
docs: update installation instructions
87+
88+
feat!: change API interface
89+
BREAKING CHANGE: new API is not compatible with previous versions
90+
```
91+
4792
## For adminer of repo
4893

94+
### Generate changelog and bump version
95+
96+
```sh
97+
melos version
98+
```
99+
100+
The command will generate changelog and bump version.
101+
102+
Next:
103+
104+
```sh
105+
git push # to publish code to github
106+
git push --tags # to publish tags to github
107+
# or
108+
git push --follow-tags # the command will push code and tags to github
109+
```
110+
111+
If the package is the main package, you should create new release on github.
112+
113+
When the tag pushed to github, the action will publish the package to pub.dev.
114+
115+
### Publish a new version manually
116+
49117
Use git tag to publish a new version to `pub.dev`.
50118

51119
```sh

0 commit comments

Comments
 (0)