Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.14 KB

Contributing

Any contributions are welcome! When contributing code, please consider the following rules:

  • code indented by four spaces, no tabs. If you're using emacs, M-< M-> M-x untabify is your friend.

  • use comments

  • remember to make all variables local

  • commit messages in the following format:

    short description in imperative, no trailing period
    [blank line]
    longer description
    

    for example:

    add this file [instead of “added” or “adding” or “adds”]
    
    The file does this and that. Note line X: I considered using Z instead of Y, but that caused problems with ABC.
    

    as for the length of the first line: if possible, use <= 50 characters (if you're using vim, just keep it yellow)

  • use common sense (read: I can't be bothered to write a full guide)

Legal thingies

The content of this repository is released under the MIT License as provided in the LICENSE file that accompanied this code.

By submitting a "pull request" or otherwise contributing to this repository, you agree to license your contribution under the license mentioned above.