From 133c6beafa0cd8c936377ab351e5544f0033cb59 Mon Sep 17 00:00:00 2001 From: jonpas Date: Thu, 25 Feb 2016 22:50:58 +0100 Subject: [PATCH 1/3] Improve GitHub files --- .github/CONTRIBUTING.md | 8 +++----- .github/ISSUE_TEMPLATE.md | 23 ++++++++++------------- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++---------- 3 files changed, 17 insertions(+), 28 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 33ae67cc0e..8eb5664cf5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,11 +6,9 @@ If you have found an issue with ACE3 please make sure that ACE3 really is the ca 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. -
-
Please note:
-

It's not a valid to simply remove @ace from the mod list to confirm that ACE3 is the culprit.

-

If the error happens when using a third-party mod contact the author of the appropriate mod and report the issue there.

-
+**Please note:** +- It's not a valid to simply remove @ace from the mod list to confirm that ACE3 is the culprit. +- If the error happens when using a third-party mod contact the author of the appropriate mod and report the issue there. ## Reporting the issue diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 92ba3070ce..e864049f93 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,25 +1,22 @@ -**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)* +**Arma 3 Version:** `x.xx` (stable / rc / dev) +**ACE3 Version:** `3.x.x` (stable / dev + commit hash) **Mods:** -* `@CBA_A3` -* `@ace` -* ... +- * `@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.* +- Add the list of modules you have placed on the map. Use 'None' if the error occurs without any modules. **Description:** -* *Add a detailed description of the error. This makes it easier for us to fix the issue.* +- 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.* +- Add the steps needed to reproduce the issue. **Where did the issue occur?** -* *A possible answer might be "Dedicated Server", "Local Multiplayer", "Editor", or "Singleplayer"* +- Dedicated / Self-Hosted Multiplayer / Singleplayer / Editor (Singleplayer) / Editor (Multiplayer) / Virtual Arsenal **RPT log 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)* +- Add a link ([gist](https://gist.github.com) or [pastebin](http://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 index 982d6137ef..f96a900cb7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,4 @@ -### 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) +**When merged this pull request will:** +- Describe what this pull request will do +- Each change in a separate line +- Respect the [Development Guidelines](http://ace3mod.com/wiki/development/) From d9179d6907f02f9bb5433f3e9029eafaf1f4a687 Mon Sep 17 00:00:00 2001 From: jonpas Date: Thu, 25 Feb 2016 23:03:40 +0100 Subject: [PATCH 2/3] Improve further --- .github/ISSUE_TEMPLATE.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e864049f93..c6f709da29 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,12 +2,8 @@ **ACE3 Version:** `3.x.x` (stable / dev + commit hash) **Mods:** -- * `@CBA_A3` -- `@ace` -- ... - -**Placed Modules:** -- Add the list of modules you have placed on the map. Use 'None' if the error occurs without any modules. +- `@CBA_A3` +- `@ace` **Description:** - Add a detailed description of the error. This makes it easier for us to fix the issue. @@ -18,5 +14,12 @@ **Where did the issue occur?** - Dedicated / Self-Hosted Multiplayer / Singleplayer / Editor (Singleplayer) / Editor (Multiplayer) / Virtual Arsenal +**Placed Modules:** +- Add the list of modules you have placed on the map. Use 'None' if the error occurs without any modules. + +**ACE Debug:** +- Add a link ([gist](https://gist.github.com) or [pastebin](http://pastebin.com)) to the ACE Debug + **RPT log file:** - Add a link ([gist](https://gist.github.com) or [pastebin](http://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). +- If possible at the time the bug is encountered, go to ACE Options and select "Debug To Clipboard", this will print extensive debug information to the RPT file. From e425483054498fd6a6206747ae854937d7986ad2 Mon Sep 17 00:00:00 2001 From: jonpas Date: Thu, 25 Feb 2016 23:04:16 +0100 Subject: [PATCH 3/3] Remove redundant line --- .github/ISSUE_TEMPLATE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c6f709da29..097b824779 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -17,9 +17,6 @@ **Placed Modules:** - Add the list of modules you have placed on the map. Use 'None' if the error occurs without any modules. -**ACE Debug:** -- Add a link ([gist](https://gist.github.com) or [pastebin](http://pastebin.com)) to the ACE Debug - **RPT log file:** - Add a link ([gist](https://gist.github.com) or [pastebin](http://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). - If possible at the time the bug is encountered, go to ACE Options and select "Debug To Clipboard", this will print extensive debug information to the RPT file.