prestodb/presto

Consider using the opinionated-commit-message Github Action

Open

#23967 opened on Nov 6, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Java (15,558 stars) (5,240 forks)batch import
feature requestgood first issue

Description

Expected Behavior or Use Case

Add automation for our commit standards so that reviewers make less mistakes and contributors get automated feedback on their commits.

Presto Component, Service, or Connector

GitHub

Possible Implementation

Use this Github Action: https://github.com/mristin/opinionated-commit-message

Example Screenshots (if appropriate):

Context

We would like to automate commit message reviews so that less mistakes are made.

Contributor guide

Tech stack
github actions
Domain
ci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basics of GitHub Actionsknowledge of YAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, examine the 'mristin/opinionated commit message' GitHub Action to understand its configuration options and required inputs. Then, look at the existing commit standards in the CONTRIBUTING.md file (link in issue) to map which rules need to be enforced. Finally, create a new workflow file (e.g., .github/workflows/commit message.yml) that triggers on pull request events and uses the action with appropriate settings. Test by creating a sample PR with a non conforming commit message.