Skip to content

Commit e00bea0

Browse files
classabbyampabenson
authored andcommitted
CONTRIBUTING.md: add instructions for testing PRs
1 parent 90cb7f2 commit e00bea0

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,25 @@ Please abstain from temporarily closing a pull request while revising the templa
129129

130130
Once the reviewers have merged the pull request, our [build server](http://build.voidlinux.org) is automatically triggered and builds
131131
all packages in the pull request for all supported platforms. Upon completion, the packages are available to all Void Linux users.
132+
133+
## Testing Pull Requests
134+
135+
While it is the responsibility of the PR creator to test changes before sending it, one person can't test all configuration options, usecases, hardware, etc.
136+
Testing new package submissions and updates is always helpful, and is a great way to get started with contributing.
137+
First, [clone the repository](https://github.com/void-linux/void-packages#quick-start) if you haven't done so already.
138+
Then check out the pull request, either with `github-cli`:
139+
140+
$ gh pr checkout <number>
141+
142+
Or with `git`:
143+
144+
If your local void-packages repository is cloned from your fork, you may need to add the main repository as a remote first:
145+
146+
$ git remote add upstream https://github.com/void-linux/void-packages.git
147+
148+
Then fetch and check out the PR (replacing `<remote>` with either `origin` or `upstream`):
149+
150+
$ git fetch <remote> pull/<number>/head:<branch-name>
151+
$ git checkout <branch-name>
152+
153+
Then [build and install](https://github.com/void-linux/void-packages#building-packages) the package and test its functionality.

0 commit comments

Comments
 (0)