How-to-Contribute/Contribution-Guidelines.md

   1 # Contribution Guidelines
   2
   3 When making any contributions/changes/updates to the repository, please follow the following guidelines:
   4
   5 ### General Guidelines
   6
   7 - Seperate words in filenames with a hyphen: `Example-of-a-Filename`
   8 - Use [Title Case](http://blog.apastyle.org/apastyle/2012/03/title-case-and-sentence-case-capitalization-in-apa-style.html) for filenames and titles if possible, http://titlecapitalization.com/# can help.
   9 - Do not upload any image or non-text files, host them on [pomf.se](http://pomf.se/), [mediacru.sh](https://mediacru.sh/), [volafile.io](https://volafile.io/) etc. and link to them from here like so:
  10
  11 ```
  12 Image files: (displays the image, alternative text shows while the image loads)
  13 ![alternative text](http://link-to-image.image-extension)
  14
  15 Other: (displays the text and links to file)
  16 [text](http://link-to-file)
  17 ```
  18 This is to keep the Git repository light.
  19 - Use [markdown](https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md) instead of HTML in .md files, GitLab strips out any HTML not contained in code blocks (the inline-HTML section on their [markdown guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md) is incorrect)
  20 - Put 2 spaces at the end of a line if you want a line break, in addition to starting the next line on a newline ([markdown is strange like that](http://meta.stackexchange.com/questions/26011/should-the-markdown-renderer-treat-a-single-line-break-as-br)).