Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,32 @@ The instructions above will generate a test project for you.

Use `dotnet test` to test the entire project.

## Versioning and releasing
## Automated Changelog

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.
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.
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:

- build: Changes that affect the build system or external dependencies (example scopes: nuget)
- ci: Changes to our CI configuration files and scripts (example scopes: GitHub Actions, Coverage)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests

If you want to point out a breaking change, you should use `!` after the type. For example: `feat!: excellent new feature`.

### Changelog Visibility and Release Triggers

Only certain types are visible in the generated changelog:

- `feat`: ✨ New Features - New functionality added
- `fix`: 🐛 Bug Fixes - Bug fixes and corrections
- `perf`: 🚀 Performance - Performance improvements
- `refactor`: 🔧 Refactoring - Code changes that neither fix bugs nor add features
- `revert`: 🔙 Reverts - Reverted changes

## Dependencies

Expand Down
47 changes: 47 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,53 @@
{
"type": "feat",
"section": "✨ New Features"
},
{
"type": "chore",
"hidden": true,
"section": "🧹 Chore"
},
{
"type": "docs",
"hidden": true,
"section": "📚 Documentation"
},
{
"type": "perf",
"section": "🚀 Performance"
},
{
"type": "build",
"hidden": true,
"section": "🛠️ Build"
},
{
"type": "deps",
"hidden": true,
"section": "📦 Dependencies"
},
{
"type": "ci",
"hidden": true,
"section": "🚦 CI"
},
{
"type": "refactor",
"section": "🔧 Refactoring"
},
{
"type": "revert",
"section": "🔙 Reverts"
},
{
"type": "style",
"hidden": true,
"section": "🎨 Styling"
},
{
"type": "test",
"hidden": true,
"section": "🧪 Tests"
}
],
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
Expand Down
Loading