Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.62 KB

README.md

File metadata and controls

30 lines (19 loc) · 1.62 KB

Pull Request Checklist

A browser extension that inserts a checklist on GitHub pull requests and prompts users if a merge is initiated when not all checklist items are checked.

The idea behind the extension is to place a team's key concerns for codebase updates, such as tests, performance, etc., in front of users who open and review pull requests.

One key difference between this extension and GitHub's Markdown powered task list feature used in pull request templates is the target user(s) of the list. The extension's checklist can be modified both by the PR submitter and by PR reviewers, allowing it to be used as a tool for signing off on concerns during review.

The extension tracks the checking off of those items via PR comments and prompts a user who initiates a merge if not all items are checked, but the user is not prevented from merging by the extension regardless of the checklist state -- the prompt is a warning that the user can choose to proceed past.

Screenshots

Checklist on PR page

checklist

Comment automatically added after checking an item

comment

Prompt when initiating a merge of a PR with unchecked items

comment

Checklist Config

There are a few checklist items hardcoded in the config. They can be augmented or replaced on a repo-specific basis within config.js, allowing custom checklist items to be implemented for specific repos.

Local Dev Setup

$ npm install
$ npm run build