Skip to content
Snippets Groups Projects

Initie un fichier rassemblant les règles de contribution au dépôt

Open sandcha requested to merge add-contributing into master
2 files
+ 95
72
Compare changes
  • Side-by-side
  • Inline

Files

CONTRIBUTING.md 0 → 100644
+ 90
0
# Contribuer au portail LexImpact
Merci de vouloir mettre à jour ou améliorer le [portail LexImpact](https://leximpact.an.fr) !
## Composants UI
Dans le cas où les évolution concernent des composants de l'interface utilisateur, voici les librairies de référence et les principes de contribution.
### Icônes
Utiliser la librairie : https://remixicon.com/
Si le choix et trop restreint, toutes les icônes de https://iconify.design/ peuvent être utilisées.
```
<iconify-icon
class="" #utiliser les classes tailwind
icon="ri-nom-icone" #mettre le nom de l'icone.
/>
```
**Si l'icône doit être alignée avec un texte**, utiliser la class Tailwind `align-[-0.2rem]` pour ajuster l'emplacement de l'icône par rapport au texte. La taille d'une icone dans un `<span>` s'ajuste avec les class de textes, par ex. `text-lg` :
```
<span>
<iconify-icon
class="align-[-0.2rem] text-base"
icon="ri-nom-icone"
/>
Mon texte
</span>
```
### Liens/boutons
#### Boutons-outils
**Usage :** Boutons utilisés pour accéder à des fonctionnalités de l'interface.
<br>**Caractéristiques :** Discrétion. Bouton de petite taille, avec hover discret.
![image.png](./image.png)
Selon la situation l'icone peut être à droite ou à gauche. Une margin de 1 `ml-1` ou `mr-1` est toujours mise entre le texte et l'icone.
La taille de l'icône est normalement de `text-lg` mais pourra être ajustée selon le résultat. Il faudra alors modifier l'alignement avec `align-[-0.2rem]`
De type bouton :
```
<button
class="text-sm uppercase text-gray-600 hover:text-black"
on:click={}>
Changer de dispositif
<iconify-icon
class="ml-1 align-[-0.2rem] text-lg"
icon="ri-arrow-up-line"/>
</button>
```
De type lien :
```
<a
class="text-sm uppercase text-gray-600 hover:text-black"
data-sveltekit-noscroll
href="">
Changer de dispositif
<iconify-icon
class="ml-1 align-[-0.2rem] text-lg"
icon="ri-arrow-up-line"
/>
</a>
```
**Options :**
- Modifier l'emplacement du bouton, utiliser `place-self-end` / `place-selff-start`. Cette class fonctionne si le bouton est dans un `<div class="flex">` et permet d'éviter de recréer un `<div>`.
## Évolutions
Il est conseillé de créer une nouvelle branche puis d'[ouvrir une merge request](https://git.leximpact.dev/leximpact/site-accueil/leximpact-portail/-/merge_requests/new) pour toute proposition d'évolution du portail. Toutefois, cette règle n'est qu'optionnelle sur ce dépôt.
À date, il n'y a pas de suivi de version de `leximpact-portail`.
> Il est possible de vérifier cela au travers du champ `version` resté à `0.0.1` dans le fichier `./package.json`.
## Publication
Pour publier les développements réalisés sur ce dépôt sur le site `leximpact.an.fr`, il suffit de les intégrer à la branche principale `master`.
> Inutile de mettre à jour le dépôt [leximpact-portail-deploy](https://git.leximpact.dev/leximpact/site-accueil/leximpact-portail-deploy).
Loading