CONTRIBUTING.md

   1 # Contributing
   2
   3 First of all: thanks for contributing!
   4
   5 ## Code conventions
   6
   7 * Always specify zoom levels as either >= or < . Don't use = or =< or >
   8 * Open curly braces on the same line, and close on an empty line.
   9 * Two space indents. No tabs.
  10 * space after : but no before
  11
  12 ## Commits policy
  13
  14 * commits must be atomic: just one consistent change per commit
  15 * when possible, refer to an issue on the commit message, for example adding
  16   `(cf #xx)` at the end of the commit message
  17 * never commit environment related changes (like layer file path or database
  18   connection settings in the .yml)
  19
  20 ## Submitting a pull request
  21
  22 * when it makes sense, add two screenshots before/after to hightlight the changes
  23 * keep pull request as simple as possible