From 0362aa14b8f92615e18d72b256df44e26baf03d2 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 22 Mar 2016 12:19:08 +0100 Subject: [PATCH] Added issue/pr templates as per github's latest feature --- .github/CONTRIBUTING.md | 32 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 13 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ CONTRIBUTING.md | 37 -------------------------------- 4 files changed, 50 insertions(+), 37 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..fec9421be7 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,32 @@ +## Creating an Issue + +Thanks for helping us improve Evennia! + +## Making an 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. + +## Making a Pull request (PR) + +- 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* and then make a *pull request*. Read the [Contribution][3] page for instructions how. + +[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/] diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..c26f1eb3b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +#### Brief summary of issue / Description of requested feature: + + +#### Steps to reproduce the issue / Reasons for adding feature: + +1. +2. +3. + +#### Error output / Expected result of feature + + +#### Extra information, such as Evennia revision/repo/branch, operating system and ideas for how to solve / implement: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..9233a347aa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +#### Brief overview of PR changes/additions + +#### Motivation for adding to Evennia + +#### Other info (issues closed, discussion etc) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c2c4e3f876..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,37 +0,0 @@ -## 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.md)) 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