Skip to content

Commit

Permalink
Fix line length and add a little note about the format of the source …
Browse files Browse the repository at this point in the history
…code.
  • Loading branch information
funilrys committed Dec 21, 2020
1 parent 5894960 commit 9fbadc8
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
17 changes: 12 additions & 5 deletions docs/contributing/coding-conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Format

$ black PyFunceble && black tests

.. note::
You can avoid this secion if you use the :code:`production-pyfunceble` CLI
which already handles as musch as possible.

Linting
^^^^^^^

Expand All @@ -36,12 +40,13 @@ Our code should have at least 60% of coverage.
Distribution
^^^^^^^^^^^^

Our code should be shipped (after each commit) with a new version and a new :code:`version.yaml` file.
Our code should be shipped (after each commit) with a new version and a new
:code:`version.yaml` file.
That file should **ALWAYS** be generated with the following.

.. note::
An exception is granted for detached branch (not :code:`dev` nor :code:`master`)
and no code changes.
An exception is granted for detached branch
(not :code:`dev` nor :code:`master`) and no code changes.

::

Expand All @@ -51,8 +56,10 @@ That file should **ALWAYS** be generated with the following.
Commit
^^^^^^

All your commits should be - when possible - be signed with **PGP**. (More information can be found on `GitHub documentation`_)
Please note the usage of :code:`-S` into the commit command which means that we sign the commit.
All your commits should be - when possible - be signed with **PGP**.
(More information can be found on `GitHub documentation`_)
Please note the usage of :code:`-S` into the commit command which means that
we sign the commit.

The commit message may be formatted like follow:

Expand Down
18 changes: 12 additions & 6 deletions docs/contributing/submit.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
Submit changes
--------------

Before anything, please keep in mind the following. If one or more of those conditions are not filled.
Before anything, please keep in mind the following. If one or more of those
conditions are not filled.
Your Pull Request to PyFunceble may not be merged.

The :code:`master` branch is used only for releasing a new or stable version of the code.
That's why we require that all contributions/modifications must be done under the :code:`dev` or a new branch.
The :code:`master` branch is used only for releasing a new or stable version
of the code.
That's why we require that all contributions/modifications must be done under
the :code:`dev` or a new branch.

In order to gain some time and also understand what you are working on, your
pull requests submission as long as your commit descriptions should be clear
and complete as much as possible.
We do an exception to commit with minor changed but big changes should have
a complete description.

In order to gain some time and also understand what you are working on, your pull requests
submission as long as your commit descriptions should be clear and complete as much as possible.
We do an exception to commit with minor changed but big changes should have a complete description.
Please ensure to use the following method when committing a big change.

0 comments on commit 9fbadc8

Please sign in to comment.