Skip to content

Commit

Permalink
Improve doc and add new missing tags
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ash-Crow
Ash-Crow committed Oct 26, 2023
1 parent 0f16cb0 commit d2c30b5
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 23 deletions.
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Pour installer les dépendances du projet :
poetry install
```

Pour installer un nouveau paquet et l'ajouter aux dépendances :
Pour installer un nouveau paquet et l’ajouter aux dépendances :

```
poetry add <paquet>
```

Pour un paquet ne servant que pour le développement, par exemple *black* :
Pour un paquet ne servant que pour le développement, par exemple `black` :

```
poetry add --group dev <paquet>
Expand All @@ -47,10 +47,15 @@ poetry shell

## Conventions de style et vérifications automatique

Ce projet suit globalement les [conventions de style de Django](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/).
Ce projet suit globalement les [conventions de style de Django](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/).

Il utilise `ruff` et `black` pour la mise en forme et `bandit` pour repérer les failles de sécurité les plus communes.

Concernant les langues :
- le code est en anglais, y compris les commentaires, de même que le nom des branches git ;
- la documentation est en français, de même que les exemples de composants et le nom des PR ;
- Les *issues* peuvent être ouvertes dans l’une ou l’autre langue.

Pour vérifier son code, on peut intégrer le linter adapté à son IDE et aussi faire ceci :

```
Expand All @@ -70,7 +75,7 @@ Une fois la mise à jour faite, il reste à :
- lancer les tests unitaires avec `make test` ;
- ouvrir le site de test et vérifier que tous les composants s’affichent toujours bien ;
- mettre à jour la liste des composants en vérifiant depuis le site du système de design de l’État ;
- mettre à jour les composants si nécessaire, en se basant sur le site du système de design de l’État.
- mettre à jour les composants si nécessaire, en se basant sur le site du système de design de l’État (ou ouvrir des *issues*)

## Publication d’une nouvelle version

Expand All @@ -83,5 +88,3 @@ La numérotation suit le principe de [versionnage sémantique](https://semver.or
## Mise à jour de la documentation

De la même manière, lorsqu’une PR est mergée dans la branche `main`, une tâche Github Actions ([deploy-doc.yml]([./.github/workflows/deploy-doc.yml)) met à jour la documentation statique en faisant un export statique du site d’exemple.


50 changes: 33 additions & 17 deletions example_app/tag_specifics.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@
{
"title": "Carte basique",
"description": """Texte de la carte.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre à environ
cinq lignes dans le mode vertical, et deux en horizontal.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre
à environ cinq lignes dans le mode vertical, et deux en horizontal.
""",
"link": "https://www.systeme-de-design.gouv.fr/",
"image_url": "/django-dsfr/static/img/placeholder.16x9.svg",
Expand All @@ -115,8 +115,8 @@
{
"title": "Carte horizontale, largeur standard",
"description": """Texte de la carte.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre à environ
deux lignes dans le mode horizontal, et cinq en vertical.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre
à environ deux lignes dans le mode horizontal, et cinq en vertical.
""",
"link": "https://www.systeme-de-design.gouv.fr/",
"image_url": "/django-dsfr/static/img/placeholder.1x1.svg",
Expand All @@ -126,8 +126,8 @@
{
"title": "Carte horizontale, largeur tiers",
"description": """Texte de la carte.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre à environ
deux lignes dans le mode horizontal, et cinq en vertical.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre
à environ deux lignes dans le mode horizontal, et cinq en vertical.
""",
"link": "https://www.systeme-de-design.gouv.fr/",
"image_url": "/django-dsfr/static/img/placeholder.1x1.svg",
Expand All @@ -137,8 +137,8 @@
{
"title": "Carte horizontale, largeur moitié",
"description": """Texte de la carte.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre à environ
deux lignes dans le mode horizontal, et cinq en vertical.
Il peut prendre jusqu’à 200 caractères, ce qui devrait correspondre
à environ deux lignes dans le mode horizontal, et cinq en vertical.
""",
"link": "https://www.systeme-de-design.gouv.fr/",
"image_url": "/django-dsfr/static/img/placeholder.1x1.svg",
Expand Down Expand Up @@ -308,7 +308,7 @@
"title": "Citation (quote)",
"sample_data": [
{
"text": "Développer vos sites et applications en utilisant des composants prêts à l'emploi, accessibles et ergonomiques",
"text": "Développer vos sites et applications en utilisant des composants prêts à l’emploi, accessibles et ergonomiques", # noqa
"source_url": "https://www.systeme-de-design.gouv.fr/",
"author": "Auteur",
"source": "Système de Design de l'État",
Expand Down Expand Up @@ -444,7 +444,7 @@
{"label": "Tag avec lien", "link": "/django-dsfr/tags"},
{
"label": "Petit tag avec icône",
"extra_classes": "fr-tag--sm fr-icon-arrow-right-line fr-tag--icon-left",
"extra_classes": "fr-tag--sm fr-icon-arrow-right-line fr-tag--icon-left", # noqa
},
{
"label": "Tag avec action",
Expand Down Expand Up @@ -476,7 +476,7 @@
"title": "Tuile (tile)",
"sample_data": [
{
"title": "Title of the tile item",
"title": "Titre de la tuile",
"url": "/",
"image_path": "/django-dsfr/static/img/placeholder.1x1.svg",
}
Expand All @@ -492,18 +492,18 @@
[
{
"id": "sample-accordion-1",
"title": "First accordion item",
"content": "<p><b>Bold</b> and <em>emphatic</em> Example content (1)</p>",
"title": "Premier accordéon",
"content": "<p>Contenu d’exemple avec du <strong>gras</strong> et de l’<em>italique</em> (1)</p>", # noqa
},
{
"id": "sample-accordion-2",
"title": "Second accordion item",
"content": "<p><b>Bold</b> and <em>emphatic</em> Example content (2)</p>",
"title": "Deuxième accordéon",
"content": "<p>Contenu d’exemple avec du <strong>gras</strong> et de l’<em>italique</em> (2)</p>", # noqa
},
{
"id": "sample-accordion-3",
"title": "Third accordion item",
"content": "<p><b>Bold</b> and <em>emphatic</em> Example content (3)</p>",
"title": "Troisième accordéon",
"content": "<p>Contenu d’exemple avec du <strong>gras</strong> et de l’<em>italique</em> (3)</p>", # noqa
},
]
],
Expand Down Expand Up @@ -581,6 +581,10 @@
"title": "Gestionnaire de consentement (consent)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/gestionnaire-de-consentement",
},
"tooltip": {
"title": "Infobulle (tooltip)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/infobulle",
},
"toggle": {
"title": "Interrupteur (toggle)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/interrupteur",
Expand All @@ -593,6 +597,10 @@
"title": "Modale (modal)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/modale",
},
"password": {
"title": "Mot de passe (password)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mot-de-passe",
},
"navigation": {
"title": "Navigation principale (navigation)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/navigation-principale",
Expand All @@ -601,6 +609,10 @@
"title": "Partage (share)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/partage",
},
"back_to_top": {
"title": "Retour en haut de page (back to top)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/retour-en-haut-de-page",
},
"translate": {
"title": "Sélecteur de langue",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/selecteur-de-langue",
Expand All @@ -609,6 +621,10 @@
"title": "Téléchargement de fichier",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/telechargement-de-fichier",
},
"transcription": {
"title": "Transcription",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/transcription",
},
}

# There is no need for specific tags for these
Expand Down

0 comments on commit d2c30b5

Please sign in to comment.