@@ -14,23 +14,23 @@ title: Commit Check
1414
1515<div class =" grid cards " markdown >
1616
17- - :material-chart-line: ** Built in Open Source **
17+ - :material-chart-line: ** Free & Powerful **
1818
1919 ---
2020
21- Open-source and MIT-licensed. Bringing contributors together to empower impactful commit-check projects in open source and beyond .
21+ A fully open-source solution for validating commits, branches, and more — simple, reliable, and community-driven .
2222
2323- :material-cog: ** Zero Configuration**
2424
2525 ---
2626
27- Works out of the box with sensible defaults. Advanced users can customize every aspect to match their commit and branch standards .
27+ Works right out of the box with smart defaults. Power users can easily customize rules to fit their team’s workflow .
2828
2929- :material-devices: ** Works Everywhere**
3030
3131 ---
3232
33- GitHub Actions, Pre -commit, Command Line – integrate anywhere your code lives.
33+ GitHub Actions, pre -commit hooks, or the command line — integrate Commit Check anywhere your code lives.
3434
3535</div >
3636
@@ -100,17 +100,17 @@ title: Commit Check
100100
101101=== "GitHub Actions"
102102
103- Add commit-check-action to your workflow in seconds:
103+ Add Commit Check Action to your workflow in seconds:
104104
105105 ```yaml
106106 steps:
107107 - uses: actions/checkout@v5
108108 with:
109- ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit
110- fetch-depth: 0 # required for merge-base check
109+ ref: ${{ github.event.pull_request.head.sha }} # Checkout PR HEAD commit
110+ fetch-depth: 0 # Required for merge-base checks
111111 - uses: commit-check/commit-check-action@v2
112112 env:
113- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because use of pr- comments
113+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for PR comments
114114 with:
115115 message: true
116116 branch: true
@@ -122,12 +122,12 @@ title: Commit Check
122122
123123=== "Pre-commit"
124124
125- Add to your `.pre-commit-config.yaml`:
125+ Add Commit Check to your `.pre-commit-config.yaml`:
126126
127127 ```yaml
128128 repos:
129129 repo: https://github.com/commit-check/commit-check
130- rev: the tag or revision
130+ rev: < tag or revision>
131131 hooks:
132132 - id: check-message
133133 - id: check-branch
@@ -148,8 +148,10 @@ title: Commit Check
148148 # Validate message from file
149149 commit-check -m commit_message.txt
150150
151- # Validate current git commit message (from git log)
151+ # Validate the latest git commit message
152152 commit-check -m
153+
154+ # And more...
153155 ```
154156
155157---
@@ -158,7 +160,7 @@ title: Commit Check
158160
159161## Join Our Community
160162
161- ** Be part of a growing ecosystem of Commit Check developers who care about code quality .**
163+ ** Be part of a growing ecosystem of developers who care about Commit Check .**
162164
163165[ GitHub Issue :fontawesome-brands-github:] ( https://github.com/commit-check/commit-check/issues ) { .md-button }
164166[ GitHub Pull Request :fontawesome-brands-github:] ( https://github.com/commit-check/commit-check/pulls ) { .md-button }
0 commit comments