Introduce a GitHub action to validate the PR name

Open
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
dart, github-actions
Domain
ci-cd

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.

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.

Dominant language
Dart
Stars
37
Forks
23
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ml-opensource/flutter-template

All issues in ml-opensource/flutter-template

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.