diff --git a/HACKING.md b/HACKING.md index 2de4829..50e2e69 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,10 +1,11 @@ # Development -SSLsplit is being developed on Github as [droe/sslsplit][1]. +SSLsplit is being developed on Github as [droe/sslsplit][1] and uses +TravisCI for continuous integration. +[![Build Status](https://travis-ci.org/droe/sslsplit.svg?branch=master)](https://travis-ci.org/droe/sslsplit) [1]: https://github.com/droe/sslsplit - ## Reporting bugs Please use the Github issue tracker for bug reports. Including the following @@ -21,14 +22,17 @@ a git checkout produces no failed unit tests on your system. ## Contributing patches -For patch submissions, please send me pull requests on Github. If you have -larger changes in mind, feel free to open an issue first to discuss -implications. If you are interested in contributing and don't know where to -start, take a look at the [open issues][2]. In particular, [porting features -over to not yet supported platforms][3] is always very much appreciated. When -submitting code, even though it is not a requirement, it is still appreciated -if you also update the manual page and other documentation as necessary and -include as many meaningful unit tests for your code as possible. +For patch submissions, please send me pull requests on Github. Ideally, you +fork a separate feature branch off the latest `develop` branch for each of +your contributions (see below). If you have larger changes in mind, feel +free to open an issue first to discuss implications. + +If you are interested in contributing and don't know where to start, take a +look at the [open issues][2]. In particular, [porting features over to not +yet supported platforms][3] is always very much appreciated. When submitting +code, even though it is not a requirement, it is still appreciated if you +also update the manual page and other documentation as necessary and include +as many meaningful unit tests for your code as possible. [2]: https://github.com/droe/sslsplit/issues [3]: https://github.com/droe/sslsplit/labels/portability @@ -44,7 +48,7 @@ Driessen's branching model][4]. The default `master` branch points to the latest tagged release, while the `develop` branch is where development happens. When preparing a release, there may or may not be a `release/x.y.z` branch off `develop`, but in either case, the tagged release is merged back to `master`. -Larger features are developed in feature branches off the `develop` branch. +New features are developed in feature branches off the `develop` branch. [4]: http://nvie.com/posts/a-successful-git-branching-model/