Skip to content

ci: enhance PR lint and add PR guidelines to CONTRIBUTING.md#6564

Open
vividctrlalt wants to merge 4 commits intotronprotocol:developfrom
vividctrlalt:prcheck2
Open

ci: enhance PR lint and add PR guidelines to CONTRIBUTING.md#6564
vividctrlalt wants to merge 4 commits intotronprotocol:developfrom
vividctrlalt:prcheck2

Conversation

@vividctrlalt
Copy link
Contributor

Summary

  • Enhance the PR lint job in pr-check.yml with stricter validation rules aligned with CONTRIBUTING.md:
    • Merge title and description checks into a single step
    • Add no trailing period check
    • Add no capitalized description check
    • Add known scope validation (warning only, not blocking)
    • Add CONTRIBUTING.md doc link in error messages
    • Improve regex to use [^)]+ for scope matching
  • Add comprehensive PR guidelines to CONTRIBUTING.md:
    • PR Title Format rules (conventional commit format, length limits)
    • Type and Scope Reference tables (module, functional domain, feature scopes)
    • PR Description requirements
    • General Rules for PR submission

Test plan

  • Submit a PR with title ending in . → should fail
  • Submit a PR with capitalized description → should fail
  • Submit a PR with unknown scope → should show warning (not fail)
  • Submit a PR with valid title and description → should pass
  • Verify error messages include CONTRIBUTING.md link

vividcoder and others added 4 commits February 27, 2026 15:09
ci: make build job depend on PR lint check
- Add no trailing period rule for PR title
- Add no capitalized description rule
- Add known scope validation (warning only, non-blocking)
- Add CONTRIBUTING.md link in error messages
- Merge title and description checks into a single step
- Update CONTRIBUTING.md with complete commit type, scope reference,
  and PR title/description requirements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant