From e2d072973e5be425b5c98149d653bb6b1c6d137c Mon Sep 17 00:00:00 2001 From: bux Date: Thu, 18 Feb 2016 19:29:33 +0100 Subject: [PATCH] adjust wording in github templates, add pr template --- .github/CONTRIBUTING.md | 37 ++------------------------------ .github/ISSUE_TEMPLATE.md | 7 +++--- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++++++ 3 files changed, 16 insertions(+), 38 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ed17a41e67..33ae67cc0e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Before reporting -If you have found an issue with ACE3 please make sure that ACE3 is really the cause of the problem. To do this try to reproduce the issue with using only `@CBA_A3` and `@ace` on a newly created mission. +If you have found an issue with ACE3 please make sure that ACE3 really is the cause of the problem. To do this try to reproduce the issue with using only `@CBA_A3` and `@ace` on a newly created mission. Indicate if the issue appears on stable or development version. In case it is the development version, please also include the commit SHA-1 hash. @@ -14,38 +14,10 @@ Indicate if the issue appears on stable or development version. In case it is th ## Reporting the issue -Head over to the [ACE3 GitHub issue tracker](https://github.com/acemod/ACE3/issues) and press the [New issue](https://github.com/acemod/ACE3/issues/new) button in the top right corner. Add a descriptive title and copy the following issue template in to the text area: - -``` -ACE3 Version: 3.x.x -(indicate if stable or dev, if dev indicate the commit the version is based on) - -**Mods:** -* `@CBA_A3` -* `@ace` - -**Placed ACE3 Modules:** -* *Add the list of modules you have placed on the map. Use 'None' if the error occurs without using any modules.* -* You can also press the `Debug to` button in the ACE3 option menu (escape -> ACE3 options -> Debug to) and add a link (pastebin.com) to the results. - -**Description:** -* Add a detailed description of the error. This makes it easier for us to fix the issue.* - -**Steps to reproduce:** -* *Add the steps needed to reproduce the issue.* - -**Where did the issue occur?** -* A possible answer might be "Multiplayer", "Editor" or "Singleplayer"* - -**RPT log file:** -* Add a link (pastebin.com) to the client or server RPT file.* -``` +Head over to the [ACE3 GitHub issue tracker](https://github.com/acemod/ACE3/issues) and press the [New issue](https://github.com/acemod/ACE3/issues/new) button in the top right corner. Add a descriptive title and complete the issue template. A video of the issue might be helpful in resolving it faster. -GitHub uses [Markdown](http://daringfireball.net/projects/markdown/syntax) to style the output. If you want to know more about it (e.g. how to [turn text bold](https://help.github.com/articles/markdown-basics/#styling-text), how to denote [code blocks](https://help.github.com/articles/markdown-basics/#inline-formats) or [inline code](https://help.github.com/articles/markdown-basics/#multiple-lines)) have a look at the [GitHub Markdown Documentation](https://help.github.com/articles/github-flavored-markdown). - - # Feature Requests ## Background @@ -57,8 +29,3 @@ Please refrain from making requests for any planned or existing features from ei In order to avoid duplicates and keep the issue tracker organized, we have created a common issue for [ACE3 Feature requests](https://github.com/acemod/ACE3/issues/414). Any and all relevant requests should be submitted there, where they will also get discussed and evaluated. Before adding a new one, make sure to check the previous entries from the thread and do a quick search for similar suggestions; please don't reiterate requests for features that had already been accepted for inclusion, or those which were disregarded earlier. Following their approval, feature requests may be moved by moderators to a separate issue for further discussion. - -# Regarding Pull Requests (PRs) -- You want to help but don't know where to start? Check the wiki entry for [setting up the development environment](http://ace3mod.com/wiki/development/setting-up-the-development-environment.html) -- [Make sure to respect the file structure](http://ace3mod.com/wiki/development/modularity-and-pbo-structure.html) -- [Make sure to respect the coding guidelines](http://ace3mod.com/wiki/development/coding-guidelines.html) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e180f5e200..92ba3070ce 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,5 +1,5 @@ -**Arma Version:** `x.xx` -*(indicate if stable or dev*) +**Arma 3 Version:** `x.xx` +*(indicate if stable, rc or dev*) **ACE3 Version:** `3.x.x` *(indicate if stable or dev, if dev indicate the commit the version is based on)* @@ -7,6 +7,7 @@ **Mods:** * `@CBA_A3` * `@ace` +* ... **Placed Modules:** * *Add the list of modules you have placed on the map. Use 'None' if the error occurs without using any modules.* @@ -21,4 +22,4 @@ * *A possible answer might be "Dedicated Server", "Local Multiplayer", "Editor", or "Singleplayer"* **RPT log file:** -* *Add a link (pastebin.com) to the client or server RPT file.* +* *Add a link (pastebin.com) to the client and/or server RPT file. An instruction to find your RPT files can be [found here](https://community.bistudio.com/wiki/Crash_Files#Arma_3)* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..982d6137ef --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +### When merged this pull request will: + +1. *Describe what this pull request will do* +2. *Each change in a seperate line* + +--- +*Delete this line and everything below* + +- [Make sure to respect the file structure](http://ace3mod.com/wiki/development/modularity-and-pbo-structure.html) +- [Make sure to respect the coding guidelines](http://ace3mod.com/wiki/development/coding-guidelines.html)