Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md: add instructions for testing PRs #38447

Merged
merged 1 commit into from
Aug 5, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,25 @@ Please abstain from temporarily closing a pull request while revising the templa

Once the reviewers have merged the pull request, our [build server](http://build.voidlinux.org) is automatically triggered and builds
all packages in the pull request for all supported platforms. Upon completion, the packages are available to all Void Linux users.

## Testing Pull Requests

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.
Testing new package submissions and updates is always helpful, and is a great way to get started with contributing.
classabbyamp marked this conversation as resolved.
Show resolved Hide resolved
First, [clone the repository](https://github.com/void-linux/void-packages#quick-start) if you haven't done so already.
Then check out the pull request, either with `github-cli`:

$ gh pr checkout <number>

Or with `git`:

If your local void-packages repository is cloned from your fork, you may need to add the main repository as a remote first:

$ git remote add upstream https://github.com/void-linux/void-packages.git
classabbyamp marked this conversation as resolved.
Show resolved Hide resolved

Then fetch and check out the PR (replacing `<remote>` with either `origin` or `upstream`):

$ git fetch <remote> pull/<number>/head:<branch-name>
$ git checkout <branch-name>

Then [build and install](https://github.com/void-linux/void-packages#building-packages) the package and test its functionality.