aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDiogo Leal <diogo@diogoleal.com>2015-06-28 04:00:12 +0000
committerDiogo Leal <diogo@diogoleal.com>2015-06-28 21:38:16 +0000
commit0293e5f9ecd3ede87e5a82e176e0675cb215ed48 (patch)
tree7e510c65bbae02f09fd79eaa5ea62f816cc9c7f7 /CONTRIBUTING.md
parent4389fad63bf23c7b5de70eb4fe58f34f8be660d6 (diff)
downloadvoid-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar.gz
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar.bz2
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar.lz
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar.xz
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.tar.zst
void-packages-0293e5f9ecd3ede87e5a82e176e0675cb215ed48.zip
adding information to use the git commit --amend when a commit is in PR
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a3a81511fa4..3518012cbe9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,9 +36,9 @@ templates must be placed in `void-packages/srcpkgs/<pkgname>/template` where `pk
For deeper insights on the contents of template files consider reading the [manual](https://github.com/voidlinux/void-packages/blob/master/Manual.md)
There's a helper tool for creating new packages in the [xtools](https://github.com/chneukirchen/xtools) package:
-```
-xnew pkgname subpkg1 subpkg2 ...
-```
+
+ $ xnew pkgname subpkg1 subpkg2 ...
+
#### Committing your changes
@@ -59,9 +59,8 @@ If you want to describe your changes in more detail, make an empty line and add
This is also described in the [manual](https://github.com/voidlinux/void-packages/blob/master/Manual.md) in deeper detail.
There's a helper tool for comitting packages in the [xtools](https://github.com/chneukirchen/xtools) package:
-```
-xbump <pkgname>
-```
+
+ $ xbump <pkgname>
#### Starting a pull request
@@ -79,9 +78,8 @@ comply with the our guidelines. At the moment not all packages comply to the rul
reports errors on places you haven't touched. So feel free to fix those errors too.
You are encouraged to check your templates beforehand using the helper from the [xtools](https://github.com/chneukirchen/xtools) package:
-```
-xlint template
-```
+
+ $ xlint template
##### Review
@@ -90,6 +88,13 @@ your pull request will contain mistakes. It's nothing bad, it just happens.
The reviewers will comment your pull request and point out which changes are needed before the template can be included.
+We recommend having only a single commit for pull request, so if you need to make changes in commits que already has a pull resquest, use the Following commands:
+
+
+ $ git add <file>
+ $ git commit --amend
+ $ git push -f
+
##### Closing the pull request
Once you have applied all comments, the reviewers will merge your request.