ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-04 20:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: mention conventional commits (#1490)

Browse Source 
Also add build type to the allowed types.
This commit is contained in:
Sergey Kuznetsov
2024-06-25 12:55:08 +01:00
committed by GitHub
parent 062ef9f0a5
commit c761b50fa4
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/workflows/check_pr_title.yml vendored
View File

@@ -7,11 +7,9 @@ on:
jobs: jobs:
check_title: check_title:
runs-on: ubuntu-20.04 runs-on: ubuntu-20.04
permissions:
pull-requests: write
steps: steps:
- uses: ytanikin/PRConventionalCommits@1.2.0 - uses: ytanikin/PRConventionalCommits@1.2.0
with: with:
task_types: '["feat","fix","docs","test","ci","style","refactor","perf","chore","revert"]' task_types: '["build","feat","fix","docs","test","ci","style","refactor","perf","chore"]'
add_label: true add_label: true
custom_labels: '{"feat":"enhancement", "fix":"bug", "docs":"documentation", "test":"testability", "ci":"ci", "style":"refactoring", "perf":"performance", "chore":"tooling"}' custom_labels: '{"build":"build", "feat":"enhancement", "fix":"bug", "docs":"documentation", "test":"testability", "ci":"ci", "style":"refactoring", "refactor":"refactoring", "perf":"performance", "chore":"tooling"}'

3
CONTRIBUTING.md
View File

@@ -72,6 +72,9 @@ git push --force
Clio uses `ccache` to speed up compilation. If you want to use it, please make sure it is installed on your machine. Clio uses `ccache` to speed up compilation. If you want to use it, please make sure it is installed on your machine.
CMake will automatically detect it and use it if it is available. CMake will automatically detect it and use it if it is available.
## Opening a pull request
When a pull request is open CI will perform checks on the new code.
Title of the pull request and squashed commit should follow [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
## Fixing issues found during code review ## Fixing issues found during code review
While your code is in review, it's possible that some changes will be requested by reviewer(s). While your code is in review, it's possible that some changes will be requested by reviewer(s).