ml-opensource / ml-opensource/flutter-template
Introduce a GitHub action to validate the PR name
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 37
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
As we follow conventional commits, it would be nice to use this format for PR names as well.
fix/feat/chore/etc(TICKET-XXX): Name of the ticket
fix/feat/chore/etc: Changes description
To force that, we can introduce a GitHub action that validates it. I've something similar in my pet project where I validate PRs. But's a bit more complex and checks for ticket name and for the description.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the linked .github/workflows/pr_validator.yml example and the repository's existing GitHub workflow configuration. Define completion as a workflow that accepts the two stated PR-name formats and rejects names outside them, then verify it with representative pull request names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart, github-actions
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100