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: CONTRIBUTING.md
+25-2Lines changed: 25 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,9 +46,32 @@ The instructions above will generate a test project for you.
46
46
47
47
Use `dotnet test` to test the entire project.
48
48
49
-
## Versioning and releasing
49
+
## Automated Changelog
50
50
51
-
This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
51
+
Each time a release is published the changelogs will be generated automatically using [googleapis/release-please-action](https://github.com/googleapis/release-please-action). The tool will organise the changes based on the PR labels.
52
+
Please make sure you follow the latest [conventions](https://www.conventionalcommits.org/en/v1.0.0/). We use an automation to check if the pull request respects the desired conventions. You can check it [here](https://github.com/open-feature/dotnet-sdk/actions/workflows/lint-pr.yml). Must be one of the following:
53
+
54
+
- build: Changes that affect the build system or external dependencies (example scopes: nuget)
55
+
- ci: Changes to our CI configuration files and scripts (example scopes: GitHub Actions, Coverage)
56
+
- docs: Documentation only changes
57
+
- feat: A new feature
58
+
- fix: A bug fix
59
+
- perf: A code change that improves performance
60
+
- refactor: A code change that neither fixes a bug nor adds a feature
61
+
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
62
+
- test: Adding missing tests or correcting existing tests
63
+
64
+
If you want to point out a breaking change, you should use `!` after the type. For example: `feat!: excellent new feature`.
65
+
66
+
### Changelog Visibility and Release Triggers
67
+
68
+
Only certain types are visible in the generated changelog:
69
+
70
+
-`feat`: ✨ New Features - New functionality added
71
+
-`fix`: 🐛 Bug Fixes - Bug fixes and corrections
72
+
-`perf`: 🚀 Performance - Performance improvements
73
+
-`refactor`: 🔧 Refactoring - Code changes that neither fix bugs nor add features
0 commit comments