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

Adopt Conventional Commits specification #2834

Merged
merged 1 commit into from
Dec 20, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Report a bug encountered while using Liqo
labels: kind/bug
labels: fix

---

Expand Down
34 changes: 26 additions & 8 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,43 @@
changelog:
exclude:
labels:
- kind/no-changelog
- no-changelog
authors:
- dependabot
categories:
- title: ":boom: Breaking Change"
labels:
- kind/breaking
- title: ":rocket: New Features"
labels:
- kind/feature
- feat
- title: ":bug: Bug Fixes"
labels:
- kind/bug
- fix
- title: ":broom: Code Refactoring"
labels:
- kind/cleanup
- refactor
- title: ":memo: Documentation"
labels:
- kind/docs
- docs
- title: ":lipstick: Code Style"
labels:
- style
- title: ":racehorse: Performance Improvement"
labels:
- perf
- title: ":white_check_mark: Tests"
labels:
- test
- title: ":truck: Dependencies Management"
labels:
- chore
- title: ":package: Builds Management"
labels:
- build
- title: ":construction_worker: CI/CD"
labels:
- ci
- title: ":rewind: Reverts Previous Changes"
labels:
- revert
- title: Other Changes
labels:
- "*"
17 changes: 12 additions & 5 deletions .github/workflows/greeting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,15 @@ jobs:
* `/hold`, `/unhold` Add/remove the hold label to prevent merging with /merge

Make sure this PR appears in the **${{ github.event.repository.name }} changelog**, adding one of the following **labels**:
* `kind/breaking`: :boom: Breaking Change
* `kind/feature`: :rocket: New Feature
* `kind/bug`: :bug: Bug Fix
* `kind/cleanup`: :broom: Code Refactoring
* `kind/docs`: :memo: Documentation
* `feat`: :rocket: New Feature
* `fix`: :bug: Bug Fix
* `refactor`: :broom: Code Refactoring
* `docs`: :memo: Documentation
* `style`: :lipstick: Code Style
* `perf`: :racehorse: Performance Improvement
* `test`: :white_check_mark: Tests
* `chore`: :truck: Dependencies Management
* `build`: :package: Builds Management
* `ci`: :construction_worker: CI/CD
* `revert`: :rewind: Reverts Previous Changes

40 changes: 33 additions & 7 deletions docs/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,42 @@ This page lists a set of contributing guidelines, including suggestions about th

The Liqo repository structure follows the [Standard Go Project Layout](https://github.com/golang-standards/project-layout).

## Commits convention

The project adopts the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to classify commits, according to the nature of the change.
In summary, commit messages should follow the following structure:

```text
<type>[optional scope]: <description>`

[optional body]

[optional footer(s)]
```

where `<type>` is one of:

* `feat`: πŸš€ New Features
* `fix`: πŸ› Bug Fixes
* `refactor`: 🧹 Code Refactoring
* `docs`: πŸ“ Documentation
* `style`: πŸ’„Code Style
* `perf`: 🐎 Performance Improvement
* `test`: βœ… Tests
* `chore`: 🚚 Dependencies Management
* `build`: πŸ“¦ Builds Management
* `ci`: πŸ‘· CI/CD
* `revert`: βͺ Reverts Previous Changes

## PRs convention

PRs are automatically assigned the label according to the `<type>` specified in the commit message(s) (see [commits convention section](#commits-convention)).
The PR's name can contain an optional scope as prefix (e.g., `[<scope>]: ...`) indicating which component(s) is being involved in the PR.

## Release notes generation

Liqo leverages the automatic release notes generation capabilities featured by GitHub.
Specifically, PRs characterized by the following labels get included in the respective category:

* *kind/breaking*: πŸ’₯ Breaking Change
* *kind/feature*: πŸš€ New Features
* *kind/bug*: πŸ› Bug Fixes
* *kind/cleanup*: 🧹 Code Refactoring
* *kind/docs*: πŸ“ Documentation
Specifically, PRs characterized by the labels described in the [PRs convention section](#prs-convention) get included in the respective category.

## Local development

Expand Down
Loading