Skip to content

Commit

Permalink
Document revisions for ISSUES.md
Browse files Browse the repository at this point in the history
Made a few changes to improve the readability of ISSUES.md. Not a critique of anyone's writing ability, but I noticed a few areas that could cause confusions for readers.
   - Removed a few cases where unneeded words were used, leading to overly "wordy" sentences
   - Rephrased the sentence about creating GitHub issues from forum discussions, making the meaning clearer
   - Other revisions to improve readability and concision
  • Loading branch information
SkippyMcSkip authored Jul 2, 2018
1 parent 966bfea commit b5896b9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

## 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.
GitHub issues are used for everything from bug reporting to suggesting long-term ideas. You can make everything run 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.
Always 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.
Before you submit a bug always search the current list of issues to see if it has 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
- Description of the problem written in a way that enables anyone to try and recreate it

Your bug report may include:

Expand All @@ -36,15 +36,15 @@ The OS and CDDA version are very important - with the pace of changes here it is

### 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.
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 the appropriate section of the forum. You'll also get much broader exposure for your idea there. After developing a polished idea on the forum, it should be easy to make a GitHub issue for it.

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).
Please first search if something like what you have on mind has been already proposed. If so, feel free to join the discussion! If your idea is related but sufficiently different, open a new issue and 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.
You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. `COMPILING.md` if you have problems building.

## Bounties

Expand Down

0 comments on commit b5896b9

Please sign in to comment.