Skip to content

Latest commit

 

History

History
28 lines (15 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

28 lines (15 loc) · 1.3 KB

Coding style

Please adhere to the coding style throughout the project.

Always use tabs. Here is a short explanation why tabs are preferred.

Also see: How to name things in programming

NOTE: A .editorconfig file is provided, if your editor supports it.

Commits and Pull Requests

Keep the commit log as healthy as the code. It is one of the first places new contributors will look at the project.

  1. No more than one change per commit. There should be no changes in a commit which are unrelated to its message.
  2. Every commit should pass all tests on its own.
  3. Follow these conventions when writing the commit message

When filing a Pull Request, make sure it is rebased on top of most recent master. If you need to modify it or amend it in some way, you should always appropriately fixup the issues in git and force-push your changes to your fork.

Also see: Github Help: Using Pull Requests

Need help?

You can always ask for help in our IRC channel, #Hearthsim on Freenode.