diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a3efd788..8f54319a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,25 +4,36 @@ about: Create a bug report to help us improve --- +(Please follow this template, as doing so saves both you and me a lot of time. +Issues that don't follow the template may be closed.) + **Description** -[//]: # (A clear and concise description of what the bug is.) +(A clear and concise description of what the bug is, e.g.: +Every time my mob signs spawn pigs, they turn green and fly away.) **Reproduce** -[//]: # (List steps to reproduce) +(List steps to reproduce, e.g.: +1. Create a new dungeon with /dxl create +2. Place [ready] sign, [mob]/pig/0,1/D5 sign +3. Leave edit mode with /dxl leave +4. Test with /dxl play +5. Trigger ready sign and get close to the location of the pig spawn sign) **Expected behavior** -[//]: # (A clear and concise description of what you expected to happen.) +(A clear and concise description of what you expected to happen, e.g.: +I wanted the pigs to turn blue and dig mole-like tunnels instead X( ) **Screenshots / GIFs / videos** -[//]: # (If applicable, add screenshots to help explain your problem.) +(If applicable, add screenshots to help explain your problem.) **Relevant configuration files** -[//]: # (Please paste the relevant configuration files in the line between the quotation marks:) +(The three grave accents mark the beginning and end of a code block. If there are relevant configuration files, +please paste them in the lines between the accents sothat others can see if there are any syntax errors.) ``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2b108ed0..cb7fc9d1 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,12 +6,12 @@ about: Suggest an idea for this project **Please describe the use case or the problem your request is related to.** -[//]: # (A clear and concise description of what the problem is. Ex. I'm always frustrated when [...];) +(A clear and concise description of what the problem is. Ex. I'm always frustrated when [...];) **Describe the solution you'd like** -[//]: # (A clear and concise description of what you want to happen.) +(A clear and concise description of what you want to happen.) **Describe alternatives you've considered** -[//]: # (A clear and concise description of any alternative solutions or features you've considered.) +(A clear and concise description of any alternative solutions or features you've considered.) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 6b89e1bc..6c4336e2 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -6,7 +6,7 @@ about: About things you do not understand in the documentation **The feature you'd like to know more about** -[//]: # (e.g. game rules) +(e.g. game rules) **Link to the wiki article (in case it exists)** @@ -14,7 +14,8 @@ about: About things you do not understand in the documentation **Relevant configuration files** -[//]: # (Please paste the relevant configuration files in the line between the quotation marks:) +(The three grave accents mark the beginning and end of a code block. If there are relevant configuration files, +please paste them in the lines between the accents sothat others can see if there are any syntax errors.) ```