diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..345f87bcad --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Thanks for helping to improve [Evennia][1]! + +Please use the issue templates below to make it easier for us to organize things. + + * If you have an error, problem or unexpected behavior to report, use the [template for Bug reports][4]. + * If you want to request a new Evennia feature, use [Template for Feature Requests][5]. + * If you find errors in the [documentation][2], first consider fixing it yourself (it's a wiki). If you can't easily fix it or is unsure how, use the [Template for doc errors][7]. + * If you want to contribute code to Evennia, you should work in your own *fork* and make a push request. Read the [Contribution][3] page for instructions how. + +If you need further help, see the [Get and Give help][4] page. + + +[1]: http://www.evennia.com +[2]: https://github.com/evennia/evennia/wiki +[3]: https://github.com/evennia/evennia/wiki/Contributing +[4]: https%3a2f%2fgithub.com%2fevennia%2fevennia%2fwiki%2fhow%2520to%2520get%2520and%2520give%2520help +[5]: https://groups.google.com/forum/#!forum/evennia +[6]: http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb +[7]: https://github.com/evennia/evennia/issues/new?title=Bug%3a%3cshort+bug+description+here%3e&body=**A)+These+steps+will+reproduce+the+problem%3a**%0d%0a%0d%0a1.%0d%0a2.%0d%0a3.%0d%0a%0d%0a**B)+This+is+a+bug+because%3a**%0d%0a%0d%0a+**C)+Extra+information%2c+such+as+Evennia+revision%2frepo%2c+operating+system+and+ideas+for+how+to+solve%3a** +[8]: https://github.com/evennia/evennia/issues/new?title=Feature+suggestion%3a+%3cshort+description+here%3e&body=**A)+The+suggested+feature+and+how+it+is+supposed+to+work+and+behave%0d%0ato+the+end+user+(player+or+admin%2fcoder)%3a**%0d%0a%0d%0a%0d%0a**B)+This+is+why+I+think+this+new+feature+should+be+included+in+Evennia%3a**%0d%0a%0d%0a+1.%0d%0a+2.%0d%0a%0d%0a**C)+Ideas+for+implementation%3a** +[9]: https://github.com/evennia/evennia/issues/new?title=Docs%3a+%3cshort+description+here%3e%0d%0a&body=**A)+The+problem+is+with+this+documentation+page+(link)%3a**%0d%0a%0d%0a**B)+The+problem+%2f+changes+suggested%3a**