From c5b1dfb1434dd765660552d4dc8e0fc885924f50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Rolim?= Date: Thu, 23 Jul 2020 19:44:57 -0300 Subject: [PATCH] Manual: move all git info to CONTRIB, explain how to use different branch in PR. --- CONTRIBUTING.md | 19 +++++++++++++++++++ Manual.md | 16 +--------------- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a38751f55ec..240e23e00cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,19 @@ For this guide, we assume you have basic knowledge about [git](http://git-scm.or Please note that we do not accept any packages containing non-release versions, such as specific git- or svn-revisions anymore. +To get started, fork the void-linux `void-packages` git repository on GitHub and clone it: + + $ git clone git@github.com:/void-packages.git + +Once you've made changes to your forked repository, you can [submit a pull +request](#starting-a-pull-request). + +To keep your forked repository up to date, setup the `upstream` remote +to pull in new changes: + + $ git remote add upstream git://github.com/void-linux/void-packages.git + $ git pull --rebase upstream master + ### Creating a new template You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates: @@ -77,6 +90,7 @@ For further details, see the output of `./xbps-src -h`. ### Starting a pull request Once you have successfully built the package, you can start a pull request. +See https://help.github.com/articles/fork-a-repo for more information. Most pull requests should only contain a single package and dependencies which are not part of void-packages yet. @@ -111,6 +125,11 @@ If it stays inactive further, it will be closed. Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included. +Furthermore, if there are issues with your git history and you would like to use another branch for the PR, +please don't close the original and open another one. Use the following command: + + $ git push --force FORK NEW_BRANCH:BRANCH_OF_EXISTING_PR + #### Publishing the package Once the reviewers have merged the pull request, our [build server](http://build.voidlinux.org) is automatically triggered and builds diff --git a/Manual.md b/Manual.md index 5b49dc5ddd4..31aefd3d7f2 100644 --- a/Manual.md +++ b/Manual.md @@ -1991,21 +1991,7 @@ otherwise the `debug` packages won't have debugging symbols. ### Contributing via git -Fork the voidlinux `void-packages` git repository on github and clone it: - - $ git clone git@github.com:/void-packages.git - -See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to format your -commits and other tips for contributing. - -Once you've made changes to your `forked` repository you can submit -a github pull request; see https://help.github.com/articles/fork-a-repo for more information. - -To keep your forked repository always up to date, setup the `upstream` remote -to pull in new changes: - - $ git remote add upstream git://github.com/void-linux/void-packages.git - $ git pull --rebase upstream master +See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to contribute to `void-packages`. ## Help