diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 582d05f9632..f850afcda54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,19 +4,7 @@ void-packages is the backbone of the Void Linux distribution. It contains all de This document describes how you as a contributor can help adding packages, correcting bugs and adding features to void-packages. -## Packages - -There are several ways to contribute packages to Void Linux: - -### "You lazy bastard" or Package requests - -Package requests can be submitted in the form of [issues](https://github.com/voidlinux/void-packages/issues). -Please use `Package Request: ` as title when sending such a request and include at least an URL to -the homepage of the software project. - -Please note that we do not guarantee that we will fulfill your request. - -### Getting your packages into Void by yourself +## Getting your packages into Void by yourself If you really want to get a package into Void Linux we recommend you to package it yourself. We provide a [comprehensive Manual](https://github.com/voidlinux/void-packages/blob/master/Manual.md) @@ -29,7 +17,7 @@ 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. -#### Creating a new template +### Creating a new template templates must be placed in `void-packages/srcpkgs//template` where `pkgname` is the same as the pkgname variable in the template. @@ -40,7 +28,7 @@ There's a helper tool for creating new packages in the [xtools](https://github.c $ xnew pkgname subpkg1 subpkg2 ... -#### Committing your changes +### Committing your changes Once you have built your template files there are certain rules on how the commit should be named. @@ -62,7 +50,7 @@ There's a helper tool for committing packages in the [xtools](https://github.com $ xbump -#### Starting a pull request +### Starting a pull request Once you successfully build the package at least on x86 (building it on armv* is recommended too) you can start a pull request. @@ -71,7 +59,7 @@ Most pull request should only contain a single package and its dependencies whic If you make updates to packages containing a soname bump you also need to revbump all packages that are dependant. Those packages should also be part of the same pull request. -##### Travis +#### Travis Once you have started a pull request, you will get instant feedback from Travis. It will check if the templates you have changed comply with the our guidelines. At the moment not all packages comply to the rules, so if you update a package, it may happen, that Travis @@ -81,7 +69,7 @@ You are encouraged to check your templates beforehand using the helper from the $ xlint template -##### Review +#### Review GitHub reports new pull request at our IRC-Channel, so the reviewers will be instantly informed. Most of the time your pull request will contain mistakes. It's nothing bad, it just happens. @@ -95,7 +83,7 @@ We recommend having only a single commit for pull request, so if you need to mak $ git commit --amend $ git push -f -##### Closing the pull request +#### Closing the pull request Once you have applied all comments, the reviewers will merge your request. @@ -105,7 +93,7 @@ If it stays inactive further, it'll be closed. Please abstain from temporary closing a pull request while revising the templates. Only close your pull request if you're sure you don't want your changes to be included. -##### Publishing the package +#### Publishing the package Once the reviewers have merged the pull request, our [build server](http://build.voidlinux.eu) is automatically triggered and builds all packages from this pull request for all supported platforms. Once it is finished, the packages are available to all Void Linux users.