Permalink
Fetching contributors…
Cannot retrieve contributors at this time
56 lines (31 sloc) 3.26 KB

Issues

How to create new issues properly

GitHub issues are used for everything from bug reporting to long-term ideas. As such you can make everything much smoother by following some simple rules.

Rule zero

Always try to give your issue a meaningful title as this is the first thing anyone will see.

Note: [CR] and [WIP] "tags" are meaningful only for PRs. All open issues by definition are request for comments and work in progress.

Bug reports

Before you submit a bug always search the issues to see if it hasn't been reported already.

Your bug report has to include:

  • On what OS did you experience the problem (Windows, Linux, OS X etc.)
  • What version were you playing:
  • Tiles or Curses (text-based)
  • Version string (preferably full version e.g. "0.C-4547-g3f1c109", or Jenkins build number e.g. 3245)
  • Description of the problem you've found written in a way that enables anyone to try recreate it

Your bug report may include:

  • Screenshot(s) as some things are best explained visually
  • Save file (e.g. link to a dropbox upload)

Bonus points for:

  • Checking if the bug exists under latest experimental build
  • Checking if it is OS specific

The OS and CDDA version are very important - with the pace of changes here it is possible the bug you have encountered has already been fixed. After that reproducibility is the key, so write your report with all the necessary details.

Enhancements and addition ideas

We have hundreds of issues open - most of them are ideas and suggestions. If you have a general idea or anything that can't be easily described in terms of current code changes you'd be better off suggesting it in appropriate section of the forum. You'll also get much broader exposure for your idea there. And getting a polished idea from the forum to GitHub issue should be a smooth move.

Otherwise please search first if maybe something like what you have on mind has been already proposed. If so feel free to join the discussion! If you think your idea is related but sufficiently different - open a new issue and perhaps refer to the older discussion (use GitHub's #issue_number reference system).

Remember to take part in the discussion of your suggestions.

Questions

You should direct your question to the forum or ask on IRC. You should also checkout the included documentation and additional text files, e.g. COMPILING.md if you have problems building.

Bounties

We keep the development and direction of the game community-driven so placing a bounty does not necessarily mean that change will be incorporated into the main game. But it may be incorporated as a mod (or not). As such feel free to post bounties on what you like, but remember we don't do "bounty-driven" development. Good way of thinking about bounties is as encouragement for contributors to work on a particular issue, and certainly not as "paying for features".

Issue resolution

We do not assign people to issues. If you plan to work on a bug fix or a validated idea feel free to just comment about that. Actual PRs are of much greater value than any assignments. In general the first correct PR about something will be the PR that will get merged, but remember: we are using Git - you can collaborate with someone else easily by sending them patches or PRs against their PR branch.