From b196a0dde0226c3fa2e5cd8a84be46b0e9f634fd Mon Sep 17 00:00:00 2001 From: Julien Moura Date: Wed, 10 May 2023 17:26:28 +0200 Subject: [PATCH 1/2] Add official git hooks --- .pre-commit-config.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ddc5f9b --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,22 @@ +exclude: ".venv|__pycache__|tests/dev/|tests/fixtures/" +fail_fast: false +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: check-added-large-files + args: ["--maxkb=1024"] + - id: check-ast + - id: check-builtin-literals + - id: check-case-conflict + - id: check-toml + - id: check-yaml + - id: detect-private-key + - id: end-of-file-fixer + - id: fix-byte-order-marker + - id: fix-encoding-pragma + args: [--remove] + - id: name-tests-test + args: [--pytest-test-first] + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] From b0d6f95cf245f850d35170bfeeb36905518bb725 Mon Sep 17 00:00:00 2001 From: Julien Moura Date: Wed, 10 May 2023 17:26:48 +0200 Subject: [PATCH 2/2] Add git hooks to contributing guide and readme --- CONTRIBUTING.md | 11 +++++++++++ README.md | 10 ++++++++++ 2 files changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..02aa3bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Directives de contribution + +Tout d'abord, merci d'envisager de contribuer à ce projet ! + +Il s'agit principalement de lignes directrices, et non de règles. Faites preuve de discernement, et n'hésitez pas à proposer des modifications à ce document dans une pull request. + +## Git hooks + +Nous utilisons les git hooks via [pre-commit](https://pre-commit.com/) pour appliquer et vérifier automatiquement certaines "règles". Veuillez l'installer avant de pousser un commit. + +Voir le fichier de configuration correspondant : `.pre-commit-config.yaml`. diff --git a/README.md b/README.md index 400645d..4ff3c57 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,16 @@ except Exception as exc: print(exc) ``` +## Contribuer + +* Installer les dépendances de développement : + + ```sh + python3 -m pip install -e[dev] + ``` + +* Consulter les [directives de contribution](./CONTRIBUTING.md) + ## Compiler la librairie ```sh