https://github.com/emmanuelbeziat/guidelines

🎓 Des règles à suivre pour tout projet !
https://github.com/emmanuelbeziat/guidelines

bonnes-pratiques css good-practices html javascript photoshop

Last synced: about 1 year ago
JSON representation

🎓 Des règles à suivre pour tout projet !

• Host: GitHub
• URL: https://github.com/emmanuelbeziat/guidelines
• Owner: EmmanuelBeziat
• Created: 2016-06-25T00:55:26.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2020-12-11T03:39:26.000Z (over 5 years ago)
• Last Synced: 2025-03-24T03:53:20.617Z (over 1 year ago)
• Topics: bonnes-pratiques, css, good-practices, html, javascript, photoshop
• Homepage: https://emmanuelbeziat.github.io/guidelines/
• Size: 50.8 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Guidelines

Des règles à suivre pour tout projet !

---

## Principes généraux

* Tous les fichiers sont encodés en utf-8 sans BOM.

* Corriger un fichier ou un bout de code qui ne respecte pas les conventions n’est **jamais** une perte de temps.

* Indentez proprement. Sérieusement.

* Les commentaires sont importants, mais il faut commenter intelligemment : un commentaire inutile prend de la place pour rien.

* On se décide pour une langue : on nomme toutes ses variables / classes en **anglais** ou en **français** (et, si possible, les commentaires aussi), et on s’y tient : on ne jongle pas d’une langue à l’autre.

* Les TODO sont conseillés, mais il faut les détailler : rien ne dit que c’est vous qui repasserez dessus.

#### KISS: Keep It Simple, Stupid!

*La simplicité est la sophistication suprême* : un code simple est plus lisible et plus facile à maintenir.

#### DRY: Don’t repeat yourself

Si la même portion de code se retrouve deux fois ou plus dans un script, on en fait une fonction. Si la même portion de code se retrouve deux fois ou plus dans une classe, on en fait une méthode.

#### YAGNI: You aren’t gonna need it

Rien ne sert de coder une méthode qui n’a pas d’implémentation ou d’utilité immédiate.

#### Don’t be shy, ask!

Il n’y a pas de honte à demander de l’aide, surtout avant d’attaquer une nouvelle fonctionnalité.

---

## Guidelines pour HTML

1. [Généralités](html/generalites.md)

## Guidelines pour CSS (et préprocesseurs)

1. [Généralités](css/generalites.md)

2. [Bonnes pratiques](css/bonnes-pratiques.md)

3. [Performances](css/performances.md)

4. [BEM](css/bem.md)

5. [ITCSS](css/itcss.md)

6. [Préprocesseurs](css/preprocesseurs.md)

7. [Nomenclatures](css/nomenclatures.md)

## Guidelines pour Javascript

1. [Généralités](javascript/generalites.md)

2. [Bonnes pratiques](javascript/bonnes-pratiques.md)

3. [Performances](javascript/performances.md)

## Guidelines pour Photoshop / Illustrator

1. [Généralités](photoshop/generalites.md)

2. [Polices & typos](photoshop/polices.md)

## Guidelines pour de bons échanges client / prestataire

1. [Généralités](clients/generalites.md)

---

## Crédits

Ces règles ont été fortement inspirées du travail de Raphaël Goetter, Pierre-Antoine Delnatte, Christophe Porteneuve, …