| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 290e5ed commit 286f703
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -12,6 +12,9 @@ | |||
| 12 | 12 | ||
| 13 | 13 | .. image:: https://img.shields.io/gitter/room/python-gitlab/Lobby.svg | |
| 14 | 14 | :target: https://gitter.im/python-gitlab/Lobby | |
| 15 | + | ||
| 16 | + .. image:: https://img.shields.io/badge/code%20style-black-000000.svg | ||
| 17 | + :target: https://github.com/python/black | ||
| 15 | 18 | ||
| 16 | 19 | Python GitLab | |
| 17 | 20 | ============= | |
@@ -91,10 +94,27 @@ You can contribute to the project in multiple ways: | |||
| 91 | 94 | * Add unit and functional tests | |
| 92 | 95 | * Everything else you can think of | |
| 93 | 96 | ||
| 94 | - We prefer commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines>`_. | ||
| 97 | + We enforce commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines>`_. | ||
| 95 | 98 | This leads to more readable messages that are easy to follow when looking through the project history. | |
| 96 | 99 | ||
| 97 | - Provide your patches as github pull requests. Thanks! | ||
| 100 | + Please provide your patches as github pull requests. Thanks! | ||
| 101 | + | ||
| 102 | + Code-Style | ||
| 103 | + ---------- | ||
| 104 | + | ||
| 105 | + We use black as code formatter, so you'll need to format your changes using the | ||
| 106 | + `black code formatter | ||
| 107 | + <https://github.com/python/black>`_. | ||
| 108 | + | ||
| 109 | + Just run | ||
| 110 | + | ||
| 111 | + .. code-block:: bash | ||
| 112 | + | ||
| 113 | + cd python-gitlab/ | ||
| 114 | + pip3 install --user black | ||
| 115 | + black . | ||
| 116 | + | ||
| 117 | + to format your code according to our guidelines. | ||
| 98 | 118 | ||
| 99 | 119 | Running unit tests | |
| 100 | 120 | ------------------ | |
| Back | FazBrowse Home | New Git URL |
0 commit comments