|
1 | | -# GitHub Actions html/css/js |
| 1 | +# GitHub Actions HTML/CSS/JS |
2 | 2 |
|
3 | | -# Exemple Badge |
| 3 | +## Description |
| 4 | +Ce projet est un exemple d'utilisation des GitHub Actions pour automatiser les tests, le linting et d'autres tâches pour un projet HTML/CSS/JS. Il est conçu pour être didactique et facile à utiliser. |
4 | 5 |
|
5 | | -1. Badge GitHub |
6 | | -``` ![nom_du_badge] (https://github.com/nom-du-repo/workflows/nom_du_workflow/badge.svg) ``` |
| 6 | +## Installation |
7 | 7 |
|
8 | | -1. Badge Shield.io |
9 | | -```  ``` |
10 | | -- Utile pour cette réalisation : https://github.com/badges/shields/issues/8671 |
| 8 | +1. Clonez le dépôt : |
| 9 | + ```bash |
| 10 | + git clone https://github.com/<votre-utilisateur>/<nom-du-repo>.git |
| 11 | + ``` |
11 | 12 |
|
12 | | -## Badge shield.io |
| 13 | +2. Accédez au dossier du projet : |
| 14 | + ```bash |
| 15 | + cd <nom-du-repo> |
| 16 | + ``` |
13 | 17 |
|
14 | | - |
| 18 | +3. Installez les dépendances : |
| 19 | + ```bash |
| 20 | + npm install |
| 21 | + ``` |
15 | 22 |
|
16 | | -## Badge jobs |
| 23 | +## Utilisation |
17 | 24 |
|
18 | | - |
19 | | - |
20 | | - |
21 | | - |
| 25 | +### Lancer les tests |
| 26 | +- Pour exécuter les tests Jest : |
| 27 | + ```bash |
| 28 | + npm run test-jest |
| 29 | + ``` |
| 30 | +- Pour exécuter les tests Deno : |
| 31 | + ```bash |
| 32 | + deno test |
| 33 | + ``` |
| 34 | + |
| 35 | +### Lancer le linting |
| 36 | +- Pour vérifier le linting avec Super-Linter : |
| 37 | + Les erreurs de linting seront automatiquement détectées lors des pushs sur la branche `main`. |
| 38 | + |
| 39 | +## Scripts disponibles |
| 40 | + |
| 41 | +### Tests |
| 42 | +- **Jest** : |
| 43 | + ```bash |
| 44 | + npm run test-jest |
| 45 | + ``` |
| 46 | + Exécute les tests unitaires pour les fichiers JavaScript avec Jest. |
| 47 | + |
| 48 | +- **Deno** : |
| 49 | + ```bash |
| 50 | + npm run test-deno |
| 51 | + ``` |
| 52 | + Exécute les tests unitaires pour les fichiers JavaScript avec Deno. |
| 53 | + |
| 54 | +### Fichiers ignorés |
| 55 | +Un fichier `.gitignore` a été ajouté pour exclure les fichiers et dossiers suivants : |
| 56 | +- `node_modules/` |
| 57 | +- Fichiers de logs (`*.log`) |
| 58 | +- Dossiers spécifiques à Deno (`.deno_modules/`, `.deno_test_cache/`) |
| 59 | +- Fichiers système (`.DS_Store`, `Thumbs.db`) |
| 60 | +- Dossiers de couverture (`coverage/`) |
| 61 | +- Dossiers de build (`build/`, `dist/`) |
| 62 | + |
| 63 | +## Normes de nommage |
| 64 | + |
| 65 | +### HTML/CSS/JS |
| 66 | +- **HTML** : Utilisez des noms de classes et d'identifiants en kebab-case (ex. `main-container`). |
| 67 | +- **CSS** : Respectez la méthodologie BEM (Block Element Modifier). |
| 68 | +- **JavaScript** : Utilisez le camelCase pour les variables et fonctions, et PascalCase pour les classes. |
| 69 | + |
| 70 | +### Nom du dépôt |
| 71 | +- Utilisez des noms descriptifs en kebab-case (ex. `action-git-html-css-js`). |
| 72 | + |
| 73 | +## Badges |
| 74 | + |
| 75 | +### Exemple Badge GitHub |
| 76 | +```markdown |
| 77 | + |
| 78 | +``` |
| 79 | + |
| 80 | +### Exemple Badge Shield.io |
| 81 | +```markdown |
| 82 | + |
| 83 | +``` |
| 84 | + |
| 85 | +## Contribuer |
| 86 | +Les contributions sont les bienvenues ! Veuillez suivre les étapes suivantes : |
| 87 | +1. Forkez le projet. |
| 88 | +2. Créez une branche pour votre fonctionnalité : `git checkout -b feature/ma-fonctionnalite`. |
| 89 | +3. Faites vos modifications et testez-les. |
| 90 | +4. Soumettez une pull request. |
0 commit comments