Hello! We are running our annual fundraising. Please consider making a donation if you value this freely available service or want to support people around the world working towards liberatory social change. https://riseup.net/donate.

Commit f66dcd89 authored by anarcat's avatar anarcat
Browse files

patches merging guidelines

we try to tell people what is a good patch, and also try to enforce reviews

this is part of the C4 RFC, which was found to be too complex to use directly
parent 9df8a338
......@@ -289,6 +289,31 @@ If you prefer old school, offline email systems, you can also use the
Debian BTS, as described above, or send patches to the mailing list for
discussion.
Some guidelines for patches:
* A patch should be a minimal and accurate answer to exactly one
identified and agreed problem.
* A patch must compile cleanly and pass project self-tests on at least
the principle target platform.
* A patch commit message must consist of a single short (less than 50
characters) line stating the a summary of the change, followed by a
blank line and then a description of the problem being solved and
its solution, or a reason for the change. Write more information,
not less, in the commit log.
Maintainers should not merge their own patches unless there is no
response from other maintainers within a reasonable time frame (1-2
days).
.. note:: Those guidelines were inspired by the `Collective Code
Construct Contract`_. The document was found to be a little
too complex and hard to read and wasn't adopted in its
entirety. See `those discussions
<https://github.com/zeromq/rfc/issues?utf8=%E2%9C%93&q=author%3Aanarcat%20>`_
for more information.
.. _Collective Code Construct Contract: https://rfc.zeromq.org/spec:42/C4/
Unit tests
==========
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment