## Creating an Issue Thanks for helping us improve Evennia! Please use one of the issue templates below: * [Issue/Bug report template][A] - when you have an error, problem or unexpected behavior to report. Note that pure usage questions belong on the [mailing list][5] or in the [chat][6]. * [Feature request template][B] - when you have an idea for a new Evennia feature. * [Documentation error template][C] - when you find an error in the [documentation][2]. Please note that the documentation is a wiki, so consider if you can easily fix the problem yourself first. * [Empty template][D] - for issues not covered by the other templates, like long-term tasks and reminders. If you want to contribute code to Evennia, you should work in your own Github *fork* (see our [style guide](https://github.com/evennia/evennia/blob/master/CODING_STYLE.txt)) and then make a *pull request*. Read the [Contribution][3] page for instructions how. ## Formatting your Issue Issues are formatted using [markdown][7]. Here is some useful markdown syntax: - \**italic text*\* - \*\***bold text**\*\* - \[link text\]\(url\) - \``inline code`\` - \`\`\````multiline code```\`\`\` 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. [1]: http://www.evennia.com [2]: https://github.com/evennia/evennia/wiki [3]: https://github.com/evennia/evennia/wiki/Contributing [4]: https://github.com/evennia/evennia/wiki/how%20to%20get%20and%20give%20help [5]: https://groups.google.com/forum/#!forum/evennia [6]: http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb [7]: https://help.github.com/articles/github-flavored-markdown/] [A]: https://github.com/evennia/evennia/issues/new?title=Bug%3a+%3cdescriptive+title+here%3e&body=%23%23%23%23+Steps+to+reproduce+the+issue%3a%0d%0a%0d%0a1.+%0d%0a2.+%0d%0a3.+%0d%0a%0d%0a%23%23%23%23+What+I+expect+to+see+and+what+I+actually+see+(tracebacks%2c+error+messages+etc)%3a%0d%0a%0d%0a%0d%0a%0d%0a%23%23%23%23+Extra+information%2c+such+as+Evennia+revision%2frepo%2fbranch%2c+operating+system+and+ideas+for+how+to+solve%3a%0d%0a%0d%0a [B]: https://github.com/evennia/evennia/issues/new?title=Feature+Request%3a+%3cdescriptive+title+here%3e&body=%23%23%23%23+Description+of+the+suggested+feature+and+how+it+is+supposed+to+work+for+the+admin%2fend+user%3a%0d%0a%0d%0a%0d%0a%23%23%23%23+A+list+of+arguments+for+why+you+think+this+new+feature+should+be+included+in+Evennia%3a%0d%0a%0d%0a1.%0d%0a2.%0d%0a%0d%0a%23%23%23%23+Extra+information%2c+such+as+requirements+or+ideas+on+implementation%3a%0d%0a%0d%0a [C]: https://github.com/evennia/evennia/issues/new?title=Docs%3a+%3cdescriptive+title+here%3e&body=%23%23%23%23+Where+in+the+documentation+to+find+the+error%3a+%0d%0a%0d%0a%0d%0a%23%23%23%23+What+the+error+is+(optionally+with+ideas+for+solution)%3a+ [D]: https://github.com/evennia/evennia/issues/new