diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fec9421be7..ab7636a01a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,9 @@ -## Creating an Issue - Thanks for helping us improve Evennia! -## Making an issue: +## Making an issue (bug report / feature request): -Issues are formatted using [markdown][7]. Here is some useful markdown syntax: +Issues are formatted using [markdown][7]. There is already a +template to fill in. Here is some useful markdown syntax: - \**italic text*\* - \*\***bold text**\*\* @@ -14,14 +13,17 @@ Issues are formatted using [markdown][7]. Here is some useful markdown syntax: Please use \``@command`\` when you mention Evennia in-game commands starting with `@`. Otherwise github will notify any github-user that -happens to be named *command*. If you need further help, see the [Get -and Give help][4] page and [www.evennia.com][1] for access to all -things Evennia. +happens to be named *command*! + +If you need further help, see the [Get and Give help][4] page and +[www.evennia.com][1] for access to all things Evennia. ## Making a Pull request (PR) - All contributions should abide by Evennia's [style guide](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md). -- Work in your own Github *fork* and then make a *pull request*. Read the [Contribution][3] page for instructions how. +- Work in your own Github *fork*. For your own sanity and ours, separate your contribution(s) in their own branches and make +- a Push request (PR) for each. You can still update the branch after the PR is up. +- Read the [Contribution][3] page for more help. [1]: http://www.evennia.com [2]: https://github.com/evennia/evennia/wiki