aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorclassabbyamp <void@placeviolette.net>2022-08-03 04:08:14 +0000
committerAndrew Benson <abenson@gmail.com>2022-08-05 00:34:35 +0000
commite00bea014c36a70d60acfa1758514b0c7cb0627d (patch)
tree3baa37356748ca4b31a4653d5a4e036064ed5d5a
parent90cb7f20a32fc61fbe8d54ffca84ae4ef8b2ae0f (diff)
downloadvoid-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar.gz
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar.bz2
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar.lz
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar.xz
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.tar.zst
void-packages-e00bea014c36a70d60acfa1758514b0c7cb0627d.zip
CONTRIBUTING.md: add instructions for testing PRs
-rw-r--r--CONTRIBUTING.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index da3bef29c88..3f33aeb1d97 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.
+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
+
+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.