Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add DCO and Breaking changes guides #62

Merged
merged 1 commit into from
Nov 28, 2024
Merged
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
28 changes: 25 additions & 3 deletions content/en/docs/Development/Dev-Semantic-Commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ weight: 10
- simple navigation through git history (e.g. ignoring style changes)

## Semantic commit message structure
`<type>(<scope>): <commit message>`
```
<type>(<scope>): <commit message>

Signed-off-by: Name <email address>
```

## The following <types> are supported
- feat (new feature for the user, not a new feature for build script)
Expand All @@ -30,13 +34,31 @@ Example <scope> values:
- etc.

## Example of semantic commit message
`fix(rest): change maven plugin order to generate the documentation correctly`
```
fix(rest): change maven plugin order to generate the documentation correctly

`<type>(<scope>): <commit message>`
Signed-off-by: John Doe <[email protected]>
```

## Referencing issues
Please reference in the pull request to the open issue

`closes eclipse/sw360#<issue-number>`

`closes eclipse/sw360#758`

## Breaking changes
If a commit is introducing a breaking change in a functionality or an endpoint,
it must be documented in the commit message by adding an exclamation `!` after
the commit type. Additional documentation for the break can be added to the
commit footer with a `BREAKING CHANGE:` message.

### Example of commit with breaking change
```
fix(rest)!: migrate health endpoint

BREAKING CHANGE: Move the health endpoint from `/resource/health` to
`/resource/api/health`.

Signed-off-by: John Doe <[email protected]>
```