michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: update CONTRIBUTING guidelines

Browse source 
Commit messages now require a body summary (before it could be blank for
"trivial" changes).

Add mention of uncrustify to help format code to project standards.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-02-09 17:52:43 -08:00 • committed by Anas Nashif
commit 23c6095ebf
1 changed files with 25 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

28
CONTRIBUTING.rst
View file

@ -250,6 +250,26 @@ various samples with advanced features that can't run in QEMU.
We highly recommend you run these tests locally to avoid any CI We highly recommend you run these tests locally to avoid any CI
failures. failures.
uncrustify
==========
The `uncrustify tool <https://sourceforge.net/projects/uncrustify>`_ can
be helpful to quickly reformat your source code to our `project coding
standards <Coding Style>`_ together with a configuration file we've provided:
.. code-block:: bash
uncrustify --replace --no-backup -l C -c
$ZEPHYR_BASE/scripts/uncrustify.cfg my_source_file.c
On Linux systems, you can install uncrustify with
.. code-block:: bash
sudo apt install uncrustify
For Windows installation instructions see the `sourceforge listing for
uncrustify <https://sourceforge.net/projects/uncrustify>`_.
Coding Style Coding Style
************ ************
@ -450,9 +470,11 @@ Commit Message Body
=================== ===================
When editing the commit message, please briefly explain what your change When editing the commit message, please briefly explain what your change
does and why it's needed. A change summary of ``"Fixes stuff"`` will be rejected. An does and why it's needed. A change summary of ``"Fixes stuff"`` will be rejected.
empty change summary is only acceptable for trivial changes fully described by
the commit title (e.g., ``doc: fix misspellings in CONTRIBUTING doc``) .. warning::
An empty change summary body is not permitted. Even for trivial changes, please
include a summary body in the commmit message.
The description body of the commit message must include: The description body of the commit message must include: