Bevry's Documentation Guidelines

(Benjamin Lupton) #1

Pull requests must conform to the following criteria:

  • GitHub Flavoured Markdown. We use GitHub Flavoured Markdown for all our documents.

  • Pull Request for each batch of similar changes. What this means is to not mix a typo fix and an entire re-writing in one pull request. Make them separate. Make as many changes as you want in one pull request, as long as they share the same goal. This allows for quicker review and a more meaningful commit history.

  • International/British English for Text, USA/American English for Code. We love it when people fix spelling errors and typos! We use International/British English for text (only 27% of our visitors are from the USA), and USA/American English for code. Code examples should (where it makes sense to) comply with the Bevry Coding Standards. If you don’t know what the differences are, no worries, still submit your pull request and we’ll merge it in and fix it up after if needed.

Bevry's Contribution Guide