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
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.md
+27-4
Original file line number
Diff line number
Diff line change
@@ -39,17 +39,40 @@ we’re thrilled that you want to contribute to `django_logging`! to ensure a po
39
39
git push origin feature/your-feature-name
40
40
```
41
41
42
-
8. **Bump Version**: Use Commitizen to update the version.
42
+
8. **Bump Version**: Use Commitizen to automatically update the version number based on commit messages.
43
+
44
+
First, confirm the current version in the Commitizen configuration (`pyproject.toml`) under `[tool.commitizen]`. For instance:
45
+
```text
46
+
[tool.commitizen]
47
+
version = "1.1.0"
48
+
```
49
+
Next, run the following command to bump the version:
43
50
```bash
44
51
cz bump
45
52
```
53
+
Commitizen will analyze your commit messages and increment the version (major, minor, or patch) according to the Conventional Commits specification.
46
54
47
-
9. **Generate Changelog**: Create a changelog with Commitizen:
55
+
9. **Generate Changelog**: Create a changelog with Commitizen(only for the new version tag):
48
56
```bash
49
-
cz changelog
57
+
cz changelog --incremental
50
58
```
59
+
the `--incremental` option limits changelog updates to only the new version tag, leaving previous entries unchanged. After generating the changelog, add it to the staging area and commit it manually:
51
60
52
-
10. **Export Dependencies**: Export the project dependencies for development and production:
61
+
```bash
62
+
git add CHANGELOG.md
63
+
git commit -m "docs: update changelog for new version"
64
+
```
65
+
This separate commit avoids including the changelog entry in the release notes, keeping them focused on code changes.
66
+
67
+
10. **Push Code and Tag**: Push the updated code and new version tag to GitHub.
68
+
69
+
```shell
70
+
git push origin feature/your-feature-name
71
+
git push origin tag <tag-name>
72
+
```
73
+
The first command pushes your code changes, and the second command pushes the new version tag created by Commitizen. This ensures that the tag is available on GitHub, which is useful for creating releases and tracking versioned changes.
74
+
75
+
11. **Export Dependencies**: Export the project dependencies for development and production:
0 commit comments