Skip to content

Commit

Permalink
Merge pull request #778 from python-gitlab/docs/readme-code-format
Browse files Browse the repository at this point in the history
docs(readme): add more info about commitlint, code-format
  • Loading branch information
gpocentek committed May 17, 2019
2 parents 290e5ed + 286f703 commit 794d64c
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.rst
Expand Up @@ -12,6 +12,9 @@

.. image:: https://img.shields.io/gitter/room/python-gitlab/Lobby.svg
:target: https://gitter.im/python-gitlab/Lobby

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black

Python GitLab
=============
Expand Down Expand Up @@ -91,10 +94,27 @@ You can contribute to the project in multiple ways:
* Add unit and functional tests
* Everything else you can think of

We prefer commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines>`_.
We enforce commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines>`_.
This leads to more readable messages that are easy to follow when looking through the project history.

Provide your patches as github pull requests. Thanks!
Please provide your patches as github pull requests. Thanks!

Code-Style
----------

We use black as code formatter, so you'll need to format your changes using the
`black code formatter
<https://github.com/python/black>`_.

Just run

.. code-block:: bash
cd python-gitlab/
pip3 install --user black
black .
to format your code according to our guidelines.

Running unit tests
------------------
Expand Down

0 comments on commit 794d64c

Please sign in to comment.