Fixed wording and some refactoring.

This commit is contained in:
Griatch 2016-03-22 14:15:31 +01:00
parent 132140d446
commit 7b80572bae

View file

@ -1,9 +1,9 @@
Thanks for helping us improve Evennia! Thanks for helping us improve Evennia! For hints of things we need help with, see the [Get and Give help][4] page.
## Making an issue (bug report / feature request): ## Making an issue (bug report / feature request):
Issues are formatted using [markdown][7]. There is already a Issues are formatted using [Markdown][7]. There is already a
template to fill in. Here is some useful markdown syntax: template to fill in. Some commonly useful markdown syntax:
- \**italic text*\* - \**italic text*\*
- \*\***bold text**\*\* - \*\***bold text**\*\*
@ -11,18 +11,16 @@ template to fill in. Here is some useful markdown syntax:
- \``inline code`\` - \``inline code`\`
- \`\`\````multiline code```\`\`\` - \`\`\````multiline code```\`\`\`
Please use \``@command`\` when you mention Evennia in-game commands Please use \``@command`\` when you mention an Evennia in-game command
starting with `@`. Otherwise github will notify any github-user that starting with `@`. Otherwise github will notify any github-user that
happens to be named *command!* 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) ## Making a Pull request (PR)
A PR allows you to request that your custom fixes/additions/changes be pulled into the main Evennia repository. To make a PR you must first [fork Evennia on GitHub][8]. Read the [Contribution][3] page for more help.
- All contributions should abide by Evennia's [style guide](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md). - 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*. For your own sanity and ours, separate unrelated contributions into separate branches and make a new Push request (PR) for each. You can still update the branch after the PR is up. - For your own sanity and ours, separate unrelated contributions into their own branches and make a new PR for each. You can still update the branch after the PR is up - the PR will update automatically.
- Read the [Contribution][3] page for more help.
[1]: http://www.evennia.com [1]: http://www.evennia.com
[2]: https://github.com/evennia/evennia/wiki [2]: https://github.com/evennia/evennia/wiki
@ -31,3 +29,4 @@ If you need further help, see the [Get and Give help][4] page and
[5]: https://groups.google.com/forum/#!forum/evennia [5]: https://groups.google.com/forum/#!forum/evennia
[6]: http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb [6]: http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb
[7]: https://help.github.com/articles/basic-writing-and-formatting-syntax/ [7]: https://help.github.com/articles/basic-writing-and-formatting-syntax/
[8]: https://guides.github.com/activities/forking/