Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add GitHub Action to enforce PR title format #1351

Merged
merged 3 commits into from
Aug 5, 2024

Conversation

Junjiequan
Copy link
Contributor

@Junjiequan Junjiequan commented Jul 31, 2024

Description

This PR introduces a title formatting check for all pull requests to maintain a consistent style across the project.

Motivation

There was a need to enforce consistent title formatting for all PRs to improve readability and maintainability. This change will ensure that all PR titles adhere to a predefined format, making them easier to understand and manage. Additionally, correct PR titles help create more complete release notes.

Changes:

  • A new PR title checker workflow has been added, which will run on every PR event such as opened, edited, synchronized, labeled, and unlabeled.
  • A new configuration file, pr-title-checker-config.json, has been created to define the rules of the title formatting.

Tests included

  • Included for each change/fix?
  • Passing? (Merge will not be approved unless this is checked)

Documentation

  • swagger documentation updated [required]
  • official documentation updated [nice-to-have]

official documentation info

If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included

@Junjiequan Junjiequan added the github_actions Pull requests that update GitHub Actions code label Jul 31, 2024
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mind leave the main README minimal and move the PR information in a dedicated file under folder docs.
Maybe something like docs/contributing/pr-guidlines.md

@Junjiequan Junjiequan requested a review from nitrosx August 1, 2024 11:02
@nitrosx nitrosx merged commit 1cd3af4 into master Aug 5, 2024
8 checks passed
@nitrosx nitrosx deleted the add-pr-title-checker-github-action branch August 5, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants