Feature: lint PR titles
Assessment
This issue has not been assessed yet.
Description
Problem Statement
Sometimes community users forget about adjusting the PR title (and merge commit) to the style guide of the Git repository. aicommit already uses the GPT model to adjust wording of particular commits, but not the PR title.
Proposal
Let's introduce aicommit lint command which can validate the proposed PR title. The command can be executed as Github Action and fail CI job if the PR does not meet style guide requirements.
Proposed Workflow
Command: aicommit lint --pr-title "fix: set dogfood go version to match go.mod"
- Load the style guide rules.
- Prepare the prompt: Ask to lint the PR title according to the style guide. Expected result: OK or suggestion.
- Exit status 0 or output the suggestion.
- Dominant language
- Go
- Stars
- 184
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from coder/aicommit
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
VLAgent `spec.k8sCollector.includePodLabels: false` has no effectPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
VictoriaMetrics/operator#2772 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Gaurav-Gosain/tuios#1316 ·
Maintainers usually reply within 1 day
-
area:auth documentation priority:low
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Mend: dependency security vulnerability
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
kube-tarian/sigrun#203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
kubernetes-csi/csi-driver-iscsi#485 ·
Maintainers usually reply within 1 day