evennia/.github/CONTRIBUTING.md
2016-03-22 14:15:31 +01:00

1.6 KiB

Thanks for helping us improve Evennia! For hints of things we need help with, see the Get and Give help page.

Making an issue (bug report / feature request):

Issues are formatted using Markdown. There is already a template to fill in. Some commonly useful markdown syntax:

  • *italic text*
  • **bold text**
  • [link text]url
  • `inline code`
  • ```multiline code```

Please use `@command` when you mention an Evennia in-game command starting with @. Otherwise github will notify any github-user that happens to be named "command"!

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. Read the Contribution page for more help.

  • All contributions should abide by Evennia's style guide.
  • 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.