GitHub Contributing Guidelines

First of all, thanks for taking the time to contribute to my project. It really means a lot. Down below are some guidlines you should follow when submitting merge requests.

This page is simply so I don’t have to update CONTRIBUTING.md on every project when I want to make changes.

Note: Each project likely has its own smaller subset of rules whilst also linking here. Please ensure you read those as well.

General

Notes

Pull Requests

Styling

Unless the code and/or project has specific requirements that contradict below, follow these coding guidlines:

  • For Vim users, you’re all set out of the box! Just don’t change your eol setting.
  • For Emacs users, add (setq require-final-newline t) to your .emacs or .emacs.d/init.el file.
  • For TextMate users, you can install the Avian Missing Bundle and add TM_STRIP_WHITESPACE_ON_SAVE = true to your .tm_properties file.
  • For Sublime users, set the "ensure_newline_at_eof_on_save" option to true.
  • For RubyMine, set “Ensure line feed at file end on Save” under “Editor.”

Questions?

If you’re confused on any of the above, shoot me an email or mention it in your PR/issue.