Skip to content

Latest commit

 

History

History
88 lines (73 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

88 lines (73 loc) · 4.58 KB
Raw

Contribute to Unknown Horizons!

We have lots of opportunities besides hacking code: Check our page on how to Get Involved!

For translation updates please use Weblate instead of submitting a pull request!

File a bug report

  • Browse the existing tickets: Maybe someone reported the bug already.
  • If there is a ticket, add a comment with additional information if you think it helps us spot the problem.
  • If there is no ticket covering your problem, please create one following some simple rules:
    1. Short and meaningful headline. Example
    2. Describe what is wrong or missing. How did you realize that? Include a step by step description so we can try to reproduce the problem. If something does not behave like you expected, please also tell us what you expected to happen. Example
    3. Logs, Savegames, screenshots and/or videos help a lot for understanding what is going on. Use the awesome uploader (login via github account) and link the additional files in your ticket.
    4. Tell us which version of Unknown Horizons and operating system do you use.

Checklist for contributing code

  • Our repository hoster, bug tracker and otherwise awesome development platform is GitHub. Sign up if you have no account yet to get started!
  • Find something you want to improve or fix
  • Check whether our bug tracker contains a ticket for this particular something
  • If not, you can either open it or (for smaller fixes) submit a pull request describing the issue
  • Fork us and start working in a topic branch for the fork
  • Make sure to check the Coding style and Pull requests sections below

Coding style

We closely follow PEP-8. Things that are handled differently:

  • Tabs only, no spaces for indentation
  • We do not strictly enforce a line length of 79 characters, usually our code stays at around 90 columns per line
  • String formatting should prefer the Python3-style format() over the % operator
  • The majority of inline comments use one space before the comment. In the end, what matters is the comment quality, not so much its indentation.

Pull requests

Commit in small, logical sections instead of assembling one huge patch. Use the power of pull requests :)

The commit messages in your pull request should follow these common guidelines:

  • First line is a short summary, followed by a blank line and a more detailed description
  • If you are referring to a bug in our tracker, the short summary should should contain that issue number: #1322
  • Remember to explain why you do something and why you chose a certain way of doing it!
  • Wrap the commit message at 72 chars per line. If your summary is longer than that, it is no summary!

More resources

IRC

Our developers are available on IRC for all your questions: #unknown-horizons @ irc.freenode.net or via webchat.

In-code tutorial

We wrote an in-code tutorial to give you a code architecture overview before you start coding on Unknown Horizons. You find the first tutorial in run_uh.py. Starting there, just follow the instruction comments (and ask us if something is unclear or outdated!).

Epydoc

We are pretty good at standing our ground against documentation, but here you go: Epydoc. We recommend you check the in-code tutorial first however :)

A better example is FIFE epydoc which helps understanding the engine glue.

Tests

Github help