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(ci): add Github labels based on PR title #2914

Merged
merged 9 commits into from
Dec 11, 2024
Prev Previous commit
Next Next commit
docs: document the existing conventions for commits categories
  • Loading branch information
mdelapenya committed Dec 10, 2024
commit 4693160d8f888fcc7d6aa4ca2341f13a9f38bed7
9 changes: 8 additions & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -29,12 +29,19 @@ Please just be sure to:
* follow the style, naming and structure conventions of the rest of the project.
* make commits atomic and easy to merge.
* use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for the PR title. This will help us to understand the nature of the changes, and to generate the changelog after all the commits in the PR are squashed.
* Please use the `break` type for breaking changes, as these categories are considered as `breaking change` in the changelog.
mdelapenya marked this conversation as resolved.
Show resolved Hide resolved
* Please use the `security` type for security fixes, as these categories are considered as `security` in the changelog.
* Please use the `feat` type for new features, as these categories are considered as `feature` in the changelog.
* Please use the `fix` type for bug fixes, as these categories are considered as `bug` in the changelog.
* Please use the `docs` type for documentation updates, as these categories are considered as `documentation` in the changelog.
* Please use the `chore` type for housekeeping commits, including `build`, `ci`, `style`, `refactor`, `test`, `perf` and so on, as these categories are considered as `chore` in the changelog.
* Please use the `deps` type for dependency updates, as these categories are considered as `dependencies` in the changelog.

!!!important
There is a GitHub Actions workflow that will check if your PR title follows the conventional commits convention. If not, it contributes a failed check to your PR.
To know more about the conventions, please refer to the [workflow file](https://github.com/testcontainers/testcontainers-go/blob/main/.github/workflows/conventions.yml).

* use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages, as it improves the readability of the commit history, and the review process.
* use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages, as it improves the readability of the commit history, and the review process. Please follow the above conventions for the PR title.
* unless necessary, please try to **avoid pushing --force** to the published branch you submitted a PR from, as it makes it harder to review the changes from a given previous state.
* apply format running `make lint-all`. It will run `golangci-lint` for the core and modules with the configuration set in the root directory of the project. Please be aware that the lint stage on CI could fail if this is not done.
* For linting just the modules: `make -C modules lint-modules`