Skip to content

Commit

Permalink
ci: semantic versioning step 1: add PR title validation workflow (#546)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar authored and yzerk committed Apr 11, 2023
1 parent ddbd9fc commit 21cb107
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .github/workflows/lint-pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: lint-pr-title

on:
pull_request_target:
types:
- opened
- reopened
- edited
- synchronize

jobs:
main:
runs-on: ubuntu-latest

steps:
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,23 @@ Unsure where to begin contributing to Crowdin CLI? You can start by looking thro

Before sending your pull requests, make sure you followed the list below:

- Read this guidelines.
- Read this guideline.
- Read [Code of Conduct](/CODE_OF_CONDUCT.md).
- Ensure that your code adheres to standard conventions, as used in the rest of the project.
- Ensure that there are unit tests for your code.
- Run unit tests.

> **Note**
> This project uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages and PR titles.
**Commit examples:**

- chore: update dependencies
- feat: add pagination to files list
- fix: resolve issue with config validation
- docs: add documentation for commands
- refactor: extract component logic into separate module

#### Philosophy of code contribution

- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
Expand Down

0 comments on commit 21cb107

Please sign in to comment.