Archives/SSLproxy
2
0
Fork 0
mirror of https://github.com/sonertari/SSLproxy synced 2024-11-02 15:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
da47cd3fe1
SSLproxy/HACKING.md
Daniel Roethlisberger da47cd3fe1 Improve documentation of build process
2015-03-15 22:38:29 +01:00

2.3 KiB
Raw Blame History

Development

SSLsplit is being developed on Github as droe/sslsplit and uses TravisCI for continuous integration. Build Status

Reporting bugs

Please use the Github issue tracker for bug reports. Including the following information will allow faster analysis of the problem:

  • Output of sslsplit -V
  • Output of uname -a
  • Exact command line arguments used to run SSLsplit
  • The NAT redirection rules you are using, if applicable
  • For build problems, the full output of make

Before submitting a bug report, please check whether the bug is also present in the develop branch and whether running make test produces failed unit tests on your system.

Contributing patches

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. In particular, porting features over to not yet supported platforms 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.

See LICENSE.md for licensing and copyright information applying to contributions. See AUTHORS.md for the list of contributors.

Branching model

With the 0.4.10 release as a starting point, SSLsplit is using Vincent Driessen's branching model. 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. New features are developed in feature branches off the develop branch.