[damned-lies/gettext: 3/3] docs: update CONTRIBUTING with git hooks info




commit 99e1ae5835a613df3efda10569d4305f6656fabc
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date:   Mon May 3 20:21:29 2021 +0200

    docs: update CONTRIBUTING with git hooks info

 CONTRIBUTING.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5730f499..d7443b53 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -62,10 +62,17 @@ As part of your first contribution, there are a few things and skills you have t
 - `damned-lies` is written in **Python** and utilizes the **Django** web framework. It uses a **Bootstrap** 
custom theme
   as its CSS framework.
 
-
 **Note:** If you are not already familiar with Django, we recommend you to go through
 the [Django Tutorial](https://docs.djangoproject.com/en/stable/intro/tutorial01/).
 
+### Git *hooks*
+
+Some hooks are provided in this repository. They can perform some upstream checks. For instance, they can 
prevent from committing unwanted code or performing others checks. *hooks* are located in the `.githooks` 
directory. To use them, it is necessary to update the `hooksPath` property by calling:
+
+```bash
+git config core.hooksPath ./.githooks
+```
+
 # Installation
 
 ## Software requirements
@@ -95,7 +102,6 @@ You can install them on your operating system using the following command line e
   dnf install gettext intltool gnome-doc-utils itstool mariadb-devel libicu-devel libxml2-devel python-devel 
yelp-tools @development-tools
   ```
 
-
 ## Python environment
 
 Once libraries are installed on your OS, the recommended method to run `damned-lies` is to use
@@ -159,7 +165,7 @@ Once Python dependencies are installed, you will need some further steps in orde
    to [create a 
superuser](https://docs.djangoproject.com/en/stable/topics/auth/default/#creating-superusers), in order
    to access the Django admin backend.
     ```bash
-   ./manage.py createsuperuser 
+   ./manage.py createsuperuser
    ```
 
 6. You should now be able to launch the development server to check if all is running well:
@@ -255,4 +261,4 @@ class TokenBackend(ModelBackend):
 ## PEP-8 advices
 
 The eighth PEP (Python Enhancement Proposal) rules Python coding style. It’s well known as the “PEP8
-standards”. [PEP-8 is a standard for coding in Python](https://www.python.org/dev/peps/pep-0008/).
\ No newline at end of file
+standards”. [PEP-8 is a standard for coding in Python](https://www.python.org/dev/peps/pep-0008/).


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]