diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index db0b941e95..fef1a27f05 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Report a bug encountered while using Liqo -labels: kind/bug +labels: fix --- diff --git a/.github/release.yml b/.github/release.yml index 98711bd2d5..4ae14dcb20 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -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 + - feature - title: ":bug: Bug Fixes" labels: - - kind/bug + - fix - title: ":broom: Code Refactoring" labels: - - kind/cleanup + - refactor - title: ":memo: Documentation" labels: - - kind/docs + - documenation + - title: ":lipstick: Code Style" + labels: + - style + - title: ":racehorse: Performance Improvement" + labels: + - performance + - 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: - "*" diff --git a/.github/workflows/greeting.yml b/.github/workflows/greeting.yml index b5bbe96d04..c492fd0dfc 100644 --- a/.github/workflows/greeting.yml +++ b/.github/workflows/greeting.yml @@ -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 + * `feature`: :rocket: New Feature + * `fix`: :bug: Bug Fix + * `refactor`: :broom: Code Refactoring + * `documenation`: :memo: Documentation + * `style`: :lipstick: Code Style + * `performance`: :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 + diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md index cdd951ef11..c410fff0bb 100644 --- a/docs/contributing/contributing.md +++ b/docs/contributing/contributing.md @@ -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: + +* *feature*: π New Features +* *fix*: π Bug Fixes +* *refactor*: π§Ή Code Refactoring +* *documenation*: π Documentation +* *style*: πCode Style +* *performance*: π 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