aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlexis <flexibeast@gmail.com>2019-11-06 11:46:49 +0000
committerJuan RP <xtraeme@gmail.com>2019-11-09 20:29:55 +0000
commit9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9 (patch)
tree833559511e9e0c302b90c903b19fe62a87efee15 /CONTRIBUTING.md
parent7de988c458088e9eda2218e25d0270eba30ec5c2 (diff)
downloadvoid-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar.gz
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar.bz2
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar.lz
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar.xz
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.tar.zst
void-packages-9c78e9d23a9d119cf0080a6d1c7dc4fb3ce071f9.zip
Elaborate on xbump usage; advise browsing srcpkgs for examples.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4b5a5a6ef1a..077381f784e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,7 +21,7 @@ as specific git- or svn-revisions anymore.
templates must be placed in `void-packages/srcpkgs/<pkgname>/template` where `pkgname` is the same as the pkgname variable in the template.
-For deeper insights on the contents of template files consider reading the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
+For deeper insights on the contents of template files consider reading the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
There's a helper tool for creating new packages in the [xtools](https://github.com/chneukirchen/xtools) package:
@@ -46,9 +46,11 @@ 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/void-linux/void-packages/blob/master/Manual.md) in deeper detail.
-There's a helper tool for committing packages in the [xtools](https://github.com/chneukirchen/xtools) package:
+There's a helper tool for committing packages in the [xtools](https://github.com/chneukirchen/xtools) package, which can be used when adding or updating a package:
- $ xbump <pkgname>
+ $ xbump <pkgname> <git commit options>
+
+`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
### Starting a pull request