From ba3f74a34c2dc29d871c07596aadb92941d67e5b 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 | 23 ++++++++++++++++++++++- Manual.md | 16 +--------------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a38751f55ec..23dfb607873 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](https://help.github.com/articles/fork-a-repo) 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: @@ -76,7 +89,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. +Once you have successfully built the package, you can [start a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Most pull requests should only contain a single package and dependencies which are not part of void-packages yet. @@ -101,6 +114,14 @@ We recommend having only a single commit for pull request, so if you need to mak $ git add $ git commit --amend $ git push -f + +A more powerful way of modifying commits than `git commit --amend` is with `git rebase -i HEAD~9`. It allows you to join, reorder, change description of past commits and more. + +Alternatively, if there are issues with your git history, you can make another branch and push it to the existing PR: + + $ git checkout master -b + $ # do changes anew + $ git push -f : #### Closing the pull request 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