evennia/CONTRIBUTING.md

Creating an Issue

Thanks for helping us improve Evennia! Please use one of the issue templates below:

• Issue/Bug report template - when you have an error, problem or unexpected behavior to report. Note that pure usage questions belong on the mailing list or in the chat.
• Feature request template - when you have an idea for a new Evennia feature.
• Documentation error template - when you find an error in the documentation. Please note that the documentation is a wiki, so consider if you can easily fix the problem yourself first.
• Empty template - 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) and then make a pull request. Read the Contribution page for instructions how.

Formatting your Issue

Issues are formatted using markdown. 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 page and www.evennia.com for access to all things Evennia.