leanprover-community / leanprover-community/queueboard-core

Detect PRs which don't follow the PR conventions

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

Nobody has claimed this yet.

prio:low
Dominant language
Python
Stars
5
Forks
9
Avg merge
2h 58m
Merged PRs (30d)
4

Description

detecting PRs which don't follow the PR conventions would be nice. eg if there's deprecations or moves or renames, does the description contain a moves block? is https://leanprover-community.github.io/contribute/commit.html followed?

I think this should be solved in two steps:

  • A github action independent of the queueboard that performs these checks. It can add something to the "PR summary report" post, and/or tag the PR with some label.
  • A dashboard in the queueboard that lists PRs that fail some of these checks.

Once the first step is done, the second step will be easy.

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.

Research direction

Start by reading the PR conventions at https://leanprover-community.github.io/contribute/commit.html and defining which checks the independent GitHub Action must perform. Implement the action so failures appear in the PR summary report or as labels, then add the queueboard dashboard that lists failing PRs; both checklist items should be complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.