From a12cabd1606314f55743fe769d13bdc80e341762 Mon Sep 17 00:00:00 2001 From: ClementTsang Date: Sun, 27 Sep 2020 01:49:35 -0400 Subject: [PATCH] other: update github issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +++---- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/question_template.md | 4 +++- .github/pull_request_template.md | 19 ++++++++++--------- 4 files changed, 17 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 878d63f9..acd4feac 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,8 +8,7 @@ assignees: "" ### Describe the bug -_A clear and concise description of what the bug is and what the expected behaviour was._ -_If applicable, add screenshots to help explain your problem:_ +_A clear and concise description of what the bug is and what the expected behaviour was. If applicable, add screenshots to help explain your problem:_ ### To reproduce @@ -25,14 +24,14 @@ _Steps on how to reproduce the behaviour:_ ### Platform -_If relevant, please provide information on:_ - **Operating system and OS version:** **Terminal (i.e. urxvt, kitty, etc.):** **Shell (i.e. zsh, bash, etc.):** +_If relevant, please provide information on:_ + **System info (RAM, SWAP, etc.):** **Rust version (if building yourself):** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 29d04641..49594883 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,7 +8,7 @@ assignees: "" ### Describe the feature request -_Why should we consider this feature request? Describe why, and/or how you think this feature will solve the issue, or overall improve the application:_ +_What is the feature of interest? Be clear and concise._ ### Additional context/details diff --git a/.github/ISSUE_TEMPLATE/question_template.md b/.github/ISSUE_TEMPLATE/question_template.md index a941798a..32dd6b69 100644 --- a/.github/ISSUE_TEMPLATE/question_template.md +++ b/.github/ISSUE_TEMPLATE/question_template.md @@ -1,9 +1,11 @@ --- name: Question? -about: If you've just got a question, feel free to ask here. +about: If you've just got a question that isn't covered by other topics, ask away via this template. title: "" labels: "question" assignees: "" --- ### Question + +_What do you want to ask in regards to this project?_ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 71238a90..46d314a4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,12 +15,12 @@ _Remove the irrelevant ones:_ - [x] _Bug fix (non-breaking change which fixes an issue)_ - [x] _New feature (non-breaking change which adds functionality)_ - [x] _Breaking change (if this change causes breakage or new behaviour, please state what)_ -- [x] _Refactoring (some change that doesn't change functionality; if relevant state what was changed)_ -- [x] _Other (something else - please specify if relevant)_ +- [x] _Refactoring (a change that doesn't change application functionality)_ +- [x] _Other (something else - please specify)_ ## Test methodology -_If required, please state how this was tested:_ +_If relevant, please state how this was tested:_ _Furthermore, please tick which platforms this change was tested on:_ @@ -28,18 +28,19 @@ _Furthermore, please tick which platforms this change was tested on:_ - [ ] _macOS_ - [ ] _Linux_ +_If relevant, all of these platforms should be tested._ + ## Checklist -_If relevant, see if the following have been met:_ +_If relevant, ensure the following have been met:_ -- [ ] _Change has been tested to work_ -- [ ] _Areas your change affects have been linted using rustfmt_ +- [ ] _Change has been tested to work, and does not cause new breakage unless intended_ - [ ] _Code has been self-reviewed_ -- [ ] _Code has been tested and no new breakage is introduced unless intended_ -- [ ] _Passes CI tests_ - [ ] _Documentation has been added/updated if needed (README, help menu, etc.)_ +- [ ] _Passes Travis tests (clippy check and `cargo test` check)_ +- [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_ - [ ] _No merge conflicts arise from the change_ ## Other information -_Provide any other relevant information:_ +_Provide any other relevant information to this change:_