Skip to content

Commit bc63edd

Browse files
authored
chore(repo): adopt vouch with issue based workflow and require for PRs (#3022)
Adopting [https://github.com/mitchellh/vouch](vouch) so we can help potential contributors by requiring a conversation before they can submit a PR. Too many contributors have been skipping the conversation part of contributing to an OSS repo and skipping right ahead to submitting PRs <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/triggerdotdev/trigger.dev/pull/3022" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open with Devin"> </picture> </a> <!-- devin-review-badge-end -->
1 parent eaed7d0 commit bc63edd

File tree

5 files changed

+102
-0
lines changed

5 files changed

+102
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Vouch Request
2+
description: Request to be vouched as a contributor
3+
labels: ["vouch-request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Vouch Request
9+
10+
We use [vouch](https://github.com/mitchellh/vouch) to manage contributor trust. PRs from unvouched users are automatically closed.
11+
12+
To get vouched, fill out this form. A maintainer will review your request and vouch for you by commenting on this issue.
13+
- type: textarea
14+
id: context
15+
attributes:
16+
label: Why do you want to contribute?
17+
description: Tell us a bit about yourself and what you'd like to work on.
18+
placeholder: "I'd like to fix a bug I found in..."
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: prior-work
23+
attributes:
24+
label: Prior contributions or relevant experience
25+
description: Links to previous open source work, relevant projects, or anything that helps us understand your background.
26+
placeholder: "https://github.com/..."
27+
validations:
28+
required: false

.github/VOUCHED.td

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Vouched contributors for Trigger.dev
2+
# See: https://github.com/mitchellh/vouch
3+
#
4+
# Org members
5+
0ski
6+
D-K-P
7+
ericallam
8+
matt-aitken
9+
mpcgrid
10+
myftija
11+
nicktrn
12+
samejr
13+
isshaddad
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Vouch - Check PR
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, reopened]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
issues: read
11+
12+
jobs:
13+
check-pr:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: mitchellh/vouch/action/check-pr@main
18+
with:
19+
pr-number: ${{ github.event.pull_request.number }}
20+
auto-close: true
21+
require-vouch: true
22+
env:
23+
GH_TOKEN: ${{ github.token }}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Vouch - Manage by Issue
2+
3+
on:
4+
issue_comment:
5+
types: [created]
6+
7+
permissions:
8+
contents: write
9+
issues: write
10+
11+
jobs:
12+
manage:
13+
runs-on: ubuntu-latest
14+
if: >-
15+
contains(github.event.comment.body, 'vouch') ||
16+
contains(github.event.comment.body, 'denounce') ||
17+
contains(github.event.comment.body, 'unvouch')
18+
steps:
19+
- uses: actions/checkout@v4
20+
- uses: mitchellh/vouch/action/manage-by-issue@main
21+
with:
22+
comment-id: ${{ github.event.comment.id }}
23+
issue-id: ${{ github.event.issue.number }}
24+
env:
25+
GH_TOKEN: ${{ github.token }}

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,19 @@ See the [Job Catalog](./references/job-catalog/README.md) file for more.
223223
4. Navigate to your trigger.dev instance ([http://localhost:3030](http://localhost:3030/)), to see the jobs.
224224
You can use the test feature to trigger them.
225225

226+
## Getting vouched (required before opening a PR)
227+
228+
We use [vouch](https://github.com/mitchellh/vouch) to manage contributor trust. **PRs from unvouched users are automatically closed.**
229+
230+
Before you open your first pull request, you need to be vouched by a maintainer. Here's how:
231+
232+
1. Open a [Vouch Request](https://github.com/triggerdotdev/trigger.dev/issues/new?template=vouch-request.yml) issue.
233+
2. Tell us what you'd like to work on and share any relevant background.
234+
3. A maintainer will review your request and vouch for you by commenting on the issue.
235+
4. Once vouched, your PRs will be accepted normally.
236+
237+
If you're unsure whether you're already vouched, go ahead and open a PR — the check will tell you.
238+
226239
## Making a pull request
227240

228241
**If you get errors, be sure to fix them before committing.**

0 commit comments

Comments
 (0)