From 89f059ae039d2dbf7ee58230a96d135367341597 Mon Sep 17 00:00:00 2001 From: Andrew Keesler Date: Thu, 27 Aug 2020 11:44:54 -0400 Subject: [PATCH] Make feature proposal and bug report language more similar --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++--- .github/ISSUE_TEMPLATE/feature-proposal.md | 10 +++++----- doc/contributing.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b6b097be..663af15b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Tell us about a problem you are experiencing +about: Explain a problem you are experiencing title: '' labels: '' assignees: '' @@ -13,7 +13,7 @@ Hey! Thanks for opening an issue! IMPORTANT: If you believe this bug is a security issue, please don't use this template and follow our [security guidelines](/doc/security.md). -We really recommend you including screenshots and logs to help us to achieve a shared understanding of the issue. +It is recommended that you include screenshots and logs to help everyone achieve a shared understanding of the bug. --> @@ -39,4 +39,4 @@ We really recommend you including screenshots and logs to help us to achieve a s - Kernel (e.g. `uname -a`): - Others: -**What else do we need to know?** +**What else is there to know about this bug?** diff --git a/.github/ISSUE_TEMPLATE/feature-proposal.md b/.github/ISSUE_TEMPLATE/feature-proposal.md index b7b73d03..ee7c91af 100644 --- a/.github/ISSUE_TEMPLATE/feature-proposal.md +++ b/.github/ISSUE_TEMPLATE/feature-proposal.md @@ -1,6 +1,6 @@ --- name: Feature proposal -about: Suggest a way to make improve this project +about: Suggest a way to improve this project title: '' labels: '' assignees: '' @@ -11,7 +11,7 @@ assignees: '' Hey! Thanks for opening an issue! -We really recommend you including screenshots and logs to help us to achieve a shared understanding of the issue. +It is recommended you include screenshots and logs to help everyone achieve a shared understanding of the improvement. --> @@ -19,7 +19,7 @@ We really recommend you including screenshots and logs to help us to achieve a s > Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -**What is the best solution to solve the above problem?** +**What is the best solution to the above problem?** > Please provide a clear and concise description of what the solution is. @@ -29,7 +29,7 @@ We really recommend you including screenshots and logs to help us to achieve a s **How will this project improvement be tested?** -> Please include your thoughts on how we can ensure that this improvement is tested thoroughly. +> Please include your thoughts on how this improvement can be thoroughly tested. **In what environment do you hope to see this improvement?** - Pinniped server version: @@ -43,4 +43,4 @@ We really recommend you including screenshots and logs to help us to achieve a s - Kernel (e.g. `uname -a`): - Others: -**What else do we need to know?** +**What else is there to know about this improvement?** diff --git a/doc/contributing.md b/doc/contributing.md index 0dfa6807..475e5561 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -27,7 +27,7 @@ guidelines in the issue and pull request templates! ## Features To suggest a feature, please first open an -[issue](https://github.com/suzerain-io/pinniped/issues/new) and tag it with +[issue](https://github.com/suzerain-io/pinniped/issues/new?template=feature-proposal.md) and tag it with `proposal`. The project team will work with you on your feature request. Once the feature request has been validated, a [pull