Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.62 KB
Raw

Setup

  1. Download and install visual studio community
  2. Download and install Git (use git from windows command prompt OR use git and optional unix tools)
  3. Download the latest stable nuget executable, copy it to the base directory (where bootstrap.bat is)
  4. run bootstrap.bat, preferably from a command window to see any errors.
  5. Open the solution file, do a build to make sure everything is working properly. Restore nuget packages if necessary.

Creating Issues

  • Have a look at the FAQ.
  • Check if a similar issue already exists (use the search function).
  • In case of a bug/crash/problem: Add as much detail as possible, including crash reports/logs (see here).

Contributing

Coding style

  1. Always use tabs.
  2. Use LF line endings.
  3. Always place braces on new lines.
  4. Use C# 6 whenever possible.
  5. Follow the standard MS C# naming conventions (short version). Also see: How to name things in programming
  6. Know when to make exceptions.

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. Follow these conventions when writing the commit message.
  3. Keep the diffs as clean as possible. Avoid unnecessary line changes.

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

Translations

Want to help translate the app? Take a look at the HDT-Localization repository.

Need help?

You can always ask for help on Gitter or the HearthSim IRC channel, #Hearthsim on Freenode.