Skip to content

Commit

Permalink
docs: fix contributing notes + formatting
Browse files Browse the repository at this point in the history
- Several notes in the contributing guide were not displayed on the
  page due to a missing semi-colon.
- Moved the note about `git commit -s` to its proper place.
- Also standardized whitespace around sub-items in "Making changes".

Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
  • Loading branch information
nbusseneau committed May 6, 2021
1 parent 159bd9c commit 7bc182d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Documentation/contributing/development/contributing_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,11 @@ requirements have been met:

Signed-off-by: Joe Stringer <joe@cilium.io>

.. note:
.. note::

Make sure to include a blank line in between commit title and commit
description.

.. note:
Passing the ``-s`` option to ``git commit`` will add the
``Signed-of-by:`` line to your commit message automatically.
#. If any of the commits fixes a particular commit already in the tree, that
commit is referenced in the commit message of the bugfix. This ensures that
whoever performs a backport will pull in all required fixes:
Expand All @@ -96,7 +91,7 @@ requirements have been met:

Signed-off-by: André Martins <andre@cilium.io>

.. note:
.. note::

The proper format for the ``Fixes:`` tag referring to commits is to use
the first 12 characters of the git SHA followed by the full commit title
Expand All @@ -113,6 +108,11 @@ requirements have been met:
#. All commits are signed off. See the section :ref:`dev_coo`.

.. note::

Passing the ``-s`` option to ``git commit`` will add the
``Signed-off-by:`` line to your commit message automatically.

#. Document any user-facing or breaking changes in ``Documentation/install/upgrade.rst``.

#. (optional) Pick the appropriate milestone for which this PR is being
Expand Down Expand Up @@ -187,7 +187,7 @@ requirements have been met:
| ``area/*`` (Optional) | Code area this PR covers |
+------------------------------+---------------------------------------------------------------------------+

.. note:
.. note::

If you do not have permissions to set labels on your pull request. Leave
a comment and a core team member will add the labels for you. Most
Expand Down
6 changes: 6 additions & 0 deletions Documentation/contributing/development/dev_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,11 @@ Making Changes
#. If any description is required to understand your code changes, then
those instructions should be code comments instead of statements in the
commit description.

.. note::

For submitting PRs, all commits need be to signed off (``git commit -s``). See the section :ref:`dev_coo`.

#. Make sure your changes meet the following criteria:

#. New code is covered by :ref:`unit_testing`.
Expand All @@ -415,6 +420,7 @@ Making Changes
new code.
#. Follow-up commits are squashed together nicely. Commits should separate
logical chunks of code and not represent a chronological list of changes.

#. Run ``git diff --check`` to catch obvious white space violations
#. Run ``make`` to build your changes. This will also run ``make lint`` and error out
on any golang linting errors. The rules are configured in ``.golangci.yaml``
Expand Down

0 comments on commit 7bc182d

Please sign in to comment.