Giter VIP home page Giter VIP logo

guidelines's Introduction

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

Guidelines pour CSS (et préprocesseurs)

  1. Généralités
  2. Bonnes pratiques
  3. Performances
  4. BEM
  5. ITCSS
  6. Préprocesseurs
  7. Nomenclatures

Guidelines pour Javascript

  1. Généralités
  2. Bonnes pratiques
  3. Performances

Guidelines pour Photoshop / Illustrator

  1. Généralités
  2. Polices & typos

Guidelines pour de bons Ă©changes client / prestataire

  1. Généralités

Crédits

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


guidelines's People

Contributors

emmanuel-italic avatar emmanuelbeziat avatar wendymonfroy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

italic

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.