mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-09-21 05:41:26 +02:00
41f638c1eb
Insufficiently described bug fixes are still too frequent. It's a real pain to create each new maintenance release, as 3/4 of the time is spent trying to guess what problem a patch fixes, which is already important in order to decide whether to pick the fix or not, but is even more capital in order to write understandable release notes. Christopher rightfully demands that a patch tagged "BUG" MUST ABSOLUTELY describe the problem and why this problem is a bug. Describing the fix is one thing but if the bug is unknown, why would there be a fix ? How can a stable maintainer be convinced to take a fix if its author didn't care about checking whether it was a real bug ? This patch tries to explain a bit better what really needs to appear in the commit message and how to describe a bug. To be backported to all relevant stable versions.
The HAProxy documentation has been split into a number of different files for ease of use. Please refer to the following files depending on what you're looking for : - INSTALL for instructions on how to build and install HAProxy - BRANCHES to understand the project's life cycle and what version to use - LICENSE for the project's license - CONTRIBUTING for the process to follow to submit contributions The more detailed documentation is located into the doc/ directory : - doc/intro.txt for a quick introduction on HAProxy - doc/configuration.txt for the configuration's reference manual - doc/lua.txt for the Lua's reference manual - doc/SPOE.txt for how to use the SPOE engine - doc/network-namespaces.txt for how to use network namespaces under Linux - doc/management.txt for the management guide - doc/regression-testing.txt for how to use the regression testing suite - doc/peers.txt for the peers protocol reference - doc/coding-style.txt for how to adopt HAProxy's coding style - doc/internals for developer-specific documentation (not all up to date)