From 029cef757f601aba155816c9cc2c7755ea9637bb Mon Sep 17 00:00:00 2001 From: Alexis Date: Wed, 6 Nov 2019 22:46:49 +1100 Subject: [PATCH] Elaborate on xbump usage; advise browsing srcpkgs for examples. --- CONTRIBUTING.md | 8 +++++--- 1 file 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//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 + $ xbump + +`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