Skip to content

Commit

Permalink
fix modification post merge
Browse files Browse the repository at this point in the history
  • Loading branch information
Arthuino committed Jan 23, 2024
1 parent 9fc3d18 commit b6f8ae6
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 72 deletions.
51 changes: 51 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,54 @@ repos:
language: python
files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
entry: cpplint

- repo: https://github.com/PyCQA/isort
rev: 5.12.0
hooks:
- id: isort
args:
- --filter-files

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.1
hooks:
- id: ruff
args:
- --fix
- --exit-non-zero-on-fix

- repo: https://github.com/cheshirekow/cmake-format-precommit
rev: v0.6.13
hooks:
- id: cmake-format

- repo: https://github.com/pre-commit/mirrors-clang-format
rev: v17.0.3
hooks:
- id: clang-format
args:
- --style=Google

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: check-added-large-files
- id: check-ast
- id: check-executables-have-shebangs
- id: check-json
- id: check-merge-conflict
- id: check-symlinks
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: destroyed-symlinks
- id: detect-private-key
- id: end-of-file-fixer
- id: fix-byte-order-marker
- id: mixed-line-ending
- id: trailing-whitespace

- repo: https://github.com/psf/black
rev: 23.10.0
hooks:
- id: black
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
# main-tiago

Repo principal pour le code qui sera sur le robot

# INSTALLATION DE L'ENVIRONNEMENT VIRTUEL

Pour installer l'environnement virtuel nécessaire au projet, exécutez la commande suivante dans le dossier `prototyping` du dossier du projet :

```bash
bash ./setup/venv_install.sh
```

Afin de désinstaller la venv, la procédure est identique mais le script à lancer est `venv_uninstall.sh`, toujours dans le dossier `prototyping`.

```bash
bash ./setup/venv_uninstall.sh
```

Le but actuel de cette venv n'est pas de faire tourner le workspace ros, mais de pouvoir avoir un environnement commun aux prototypages.

# GIT ET L'INTEGRATION CONTINUE
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

Repo principal pour le code qui tourne sur le PC du robot Tiago.

Expand Down Expand Up @@ -87,8 +69,26 @@ Le code source du projet est sur un repo principal, qui sert de référence de l
Pour assurer la "qualité" du code produit et éviter les problèmes d'intégration, plusieurs outils plus ou moins automatisés sont utilisés :

- **cpplint** : vérifie que le code c++ est conforme aux normes de codage de Google (exigence par le client)
Cpplint est executé automatiquement avant chaque commit. Si des erreurs sont détectées, le commit est annulé et un message d'erreur est affiché. Il est donc nécessaire de corriger les erreurs avant de pouvoir commit. Il ne vérifie pas les erreurs de compilation, uniquement les erreurs de style.
Cpplint est executé automatiquement avant chaque commit. Si des erreurs sont détectées, le commit est annulé et un message d'erreur est affiché. Il est donc nécessaire de corriger les erreurs avant de pouvoir commit. Il ne vérifie pas les erreurs de compilation, uniquement les erreurs de style.

- **Google Test** : framework de test unitaire pour c++
Les tests unitaires seront tous executé avant de merge une pull request sur le repo principal. Le taux de couverture de ces tests sera vérifié.
La compilation sera également vérifiée à ce moment là.

## Prototypage Python

###  INSTALLATION DE L'ENVIRONNEMENT VIRTUEL

Pour installer l'environnement virtuel nécessaire au projet, exécutez la commande suivante dans le dossier `prototyping` du dossier du projet :

```bash
bash ./setup/venv_install.sh
```

Afin de désinstaller la venv, la procédure est identique mais le script à lancer est `venv_uninstall.sh`, toujours dans le dossier `prototyping`.

```bash
bash ./setup/venv_uninstall.sh
```

Le but actuel de cette venv n'est pas de faire tourner le workspace ros, mais de pouvoir avoir un environnement commun aux prototypages.
52 changes: 0 additions & 52 deletions pre-commit-config.yaml

This file was deleted.

0 comments on commit b6f8ae6

Please sign in to comment.