Skip to content

Commit 52d309b

Browse files
fra98adamjensenbot
authored andcommitted
feat: added new labels categories for PRs and commits
1 parent d8cf51b commit 52d309b

File tree

4 files changed

+72
-21
lines changed

4 files changed

+72
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug report
33
about: Report a bug encountered while using Liqo
4-
labels: kind/bug
4+
labels: fix
55

66
---
77

.github/release.yml

+26-8
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,43 @@
11
changelog:
22
exclude:
33
labels:
4-
- kind/no-changelog
4+
- no-changelog
55
authors:
66
- dependabot
77
categories:
8-
- title: ":boom: Breaking Change"
9-
labels:
10-
- kind/breaking
118
- title: ":rocket: New Features"
129
labels:
13-
- kind/feature
10+
- feat
1411
- title: ":bug: Bug Fixes"
1512
labels:
16-
- kind/bug
13+
- fix
1714
- title: ":broom: Code Refactoring"
1815
labels:
19-
- kind/cleanup
16+
- refactor
2017
- title: ":memo: Documentation"
2118
labels:
22-
- kind/docs
19+
- docs
20+
- title: ":lipstick: Code Style"
21+
labels:
22+
- style
23+
- title: ":racehorse: Performance Improvement"
24+
labels:
25+
- perf
26+
- title: ":white_check_mark: Tests"
27+
labels:
28+
- test
29+
- title: ":truck: Dependencies Management"
30+
labels:
31+
- chore
32+
- title: ":package: Builds Management"
33+
labels:
34+
- build
35+
- title: ":construction_worker: CI/CD"
36+
labels:
37+
- ci
38+
- title: ":rewind: Reverts Previous Changes"
39+
labels:
40+
- revert
2341
- title: Other Changes
2442
labels:
2543
- "*"

.github/workflows/greeting.yml

+12-5
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,15 @@ jobs:
2929
* `/hold`, `/unhold` Add/remove the hold label to prevent merging with /merge
3030
3131
Make sure this PR appears in the **${{ github.event.repository.name }} changelog**, adding one of the following **labels**:
32-
* `kind/breaking`: :boom: Breaking Change
33-
* `kind/feature`: :rocket: New Feature
34-
* `kind/bug`: :bug: Bug Fix
35-
* `kind/cleanup`: :broom: Code Refactoring
36-
* `kind/docs`: :memo: Documentation
32+
* `feat`: :rocket: New Feature
33+
* `fix`: :bug: Bug Fix
34+
* `refactor`: :broom: Code Refactoring
35+
* `docs`: :memo: Documentation
36+
* `style`: :lipstick: Code Style
37+
* `perf`: :racehorse: Performance Improvement
38+
* `test`: :white_check_mark: Tests
39+
* `chore`: :truck: Dependencies Management
40+
* `build`: :package: Builds Management
41+
* `ci`: :construction_worker: CI/CD
42+
* `revert`: :rewind: Reverts Previous Changes
43+

docs/contributing/contributing.md

+33-7
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,42 @@ This page lists a set of contributing guidelines, including suggestions about th
88

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

11+
## Commits convention
12+
13+
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.
14+
In summary, commit messages should follow the following structure:
15+
16+
```text
17+
<type>[optional scope]: <description>`
18+
19+
[optional body]
20+
21+
[optional footer(s)]
22+
```
23+
24+
where `<type>` is one of:
25+
26+
* `feat`: 🚀 New Features
27+
* `fix`: 🐛 Bug Fixes
28+
* `refactor`: 🧹 Code Refactoring
29+
* `docs`: 📝 Documentation
30+
* `style`: 💄Code Style
31+
* `perf`: 🐎 Performance Improvement
32+
* `test`: ✅ Tests
33+
* `chore`: 🚚 Dependencies Management
34+
* `build`: 📦 Builds Management
35+
* `ci`: 👷 CI/CD
36+
* `revert`: ⏪ Reverts Previous Changes
37+
38+
## PRs convention
39+
40+
PRs are automatically assigned the label according to the `<type>` specified in the commit message(s) (see [commits convention section](#commits-convention)).
41+
The PR's name can contain an optional scope as prefix (e.g., `[<scope>]: ...`) indicating which component(s) is being involved in the PR.
42+
1143
## Release notes generation
1244

1345
Liqo leverages the automatic release notes generation capabilities featured by GitHub.
14-
Specifically, PRs characterized by the following labels get included in the respective category:
15-
16-
* *kind/breaking*: 💥 Breaking Change
17-
* *kind/feature*: 🚀 New Features
18-
* *kind/bug*: 🐛 Bug Fixes
19-
* *kind/cleanup*: 🧹 Code Refactoring
20-
* *kind/docs*: 📝 Documentation
46+
Specifically, PRs characterized by the labels described in the [PRs convention section](#prs-convention) get included in the respective category.
2147

2248
## Local development
2349

0 commit comments

Comments
 (0)