From 7050d7bd18bde9f3ea7ab5edb079f0449af55d36 Mon Sep 17 00:00:00 2001 From: bufdev Date: Thu, 2 Jun 2022 14:24:53 -0400 Subject: [PATCH 1/5] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..c5e934d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Let us know about a bug you have found +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +Provide us with clear and concise description of what the bug is. + +**To Reproduce** +Provide us with specific steps to reproduce the behavior. In most cases, we should be able to copy and paste these steps to reproduce the issue you are seeing. In a perfect world, this would look like: +```go +mkdir tmp +cd ./tmp +go mod init example +go get github.com/bufbuild/connect-go +cat < bug_report_test.go +package bugreport + +func TestThatReproducesBug(t *testing.T) { + // your reproduction here +} +``` + +**Environment (please complete the following information):** +- `connect-go` version or commit: [e.g. `v0.1.0` or `5bfc7a1b440ebffdc952d813332e3617ca611395`] + - `go version`: [e.g. `go version go1.18.3 darwin/amd64`] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..e52c44bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an new feature or improvement +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +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. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 2b5e23de833dc43212ae79087229ae4f845d9e4b Mon Sep 17 00:00:00 2001 From: bufdev Date: Thu, 2 Jun 2022 14:32:49 -0400 Subject: [PATCH 2/5] add documentation or typo issue template --- .../ISSUE_TEMPLATE/documentation_or_typo.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation_or_typo.md diff --git a/.github/ISSUE_TEMPLATE/documentation_or_typo.md b/.github/ISSUE_TEMPLATE/documentation_or_typo.md new file mode 100644 index 00000000..24b916c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_or_typo.md @@ -0,0 +1,18 @@ +--- +name: Documentation or typo +about: Let us know about a documentation issue or typo +title: '' +labels: documentation +assignees: '' + +--- + +**Where is the documentation issue or typo?** +Provide us a link to the location, either on +[connect.build/docs](https://connect.build/docs) or within this repository. + +**What is the issue you see** +A clear and concise description of what should be changed. + +**Additional context** +Add any other context or screenshots about the feature request here. From 9df1e162b20e003669a86911308fe33cec678492 Mon Sep 17 00:00:00 2001 From: bufdev Date: Thu, 2 Jun 2022 14:35:18 -0400 Subject: [PATCH 3/5] add anything_else.md --- .github/ISSUE_TEMPLATE/anything_else.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/documentation_or_typo.md | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/anything_else.md diff --git a/.github/ISSUE_TEMPLATE/anything_else.md b/.github/ISSUE_TEMPLATE/anything_else.md new file mode 100644 index 00000000..71c6bdf6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/anything_else.md @@ -0,0 +1,13 @@ +--- +name: Anything else +about: File any other type of issue you have +title: '' +assignees: '' + +--- + +**Are you sure this issue does not fit into one of our other templates?** +Yes/no + +**What is the issue you see?** +A clear and concise description of the issue. diff --git a/.github/ISSUE_TEMPLATE/documentation_or_typo.md b/.github/ISSUE_TEMPLATE/documentation_or_typo.md index 24b916c4..3dfeea6d 100644 --- a/.github/ISSUE_TEMPLATE/documentation_or_typo.md +++ b/.github/ISSUE_TEMPLATE/documentation_or_typo.md @@ -11,7 +11,7 @@ assignees: '' Provide us a link to the location, either on [connect.build/docs](https://connect.build/docs) or within this repository. -**What is the issue you see** +**What is the issue you see?** A clear and concise description of what should be changed. **Additional context** From bf9aac55a28a254a20da62dfa26247ef35a02a45 Mon Sep 17 00:00:00 2001 From: bufdev Date: Thu, 2 Jun 2022 15:59:47 -0400 Subject: [PATCH 4/5] remove documentation template --- .github/ISSUE_TEMPLATE/anything_else.md | 6 ------ .../ISSUE_TEMPLATE/documentation_or_typo.md | 18 ------------------ 2 files changed, 24 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation_or_typo.md diff --git a/.github/ISSUE_TEMPLATE/anything_else.md b/.github/ISSUE_TEMPLATE/anything_else.md index 71c6bdf6..4732374d 100644 --- a/.github/ISSUE_TEMPLATE/anything_else.md +++ b/.github/ISSUE_TEMPLATE/anything_else.md @@ -5,9 +5,3 @@ title: '' assignees: '' --- - -**Are you sure this issue does not fit into one of our other templates?** -Yes/no - -**What is the issue you see?** -A clear and concise description of the issue. diff --git a/.github/ISSUE_TEMPLATE/documentation_or_typo.md b/.github/ISSUE_TEMPLATE/documentation_or_typo.md deleted file mode 100644 index 3dfeea6d..00000000 --- a/.github/ISSUE_TEMPLATE/documentation_or_typo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Documentation or typo -about: Let us know about a documentation issue or typo -title: '' -labels: documentation -assignees: '' - ---- - -**Where is the documentation issue or typo?** -Provide us a link to the location, either on -[connect.build/docs](https://connect.build/docs) or within this repository. - -**What is the issue you see?** -A clear and concise description of what should be changed. - -**Additional context** -Add any other context or screenshots about the feature request here. From e87e301616933235f132280b441e3f6f4422bbfb Mon Sep 17 00:00:00 2001 From: Akshay Shah Date: Thu, 2 Jun 2022 21:58:09 -0700 Subject: [PATCH 5/5] Reword some templates --- .github/ISSUE_TEMPLATE/anything_else.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 30 ++++++++++++++++------- .github/ISSUE_TEMPLATE/feature_request.md | 9 ++++--- 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/anything_else.md b/.github/ISSUE_TEMPLATE/anything_else.md index 4732374d..df3b035a 100644 --- a/.github/ISSUE_TEMPLATE/anything_else.md +++ b/.github/ISSUE_TEMPLATE/anything_else.md @@ -1,6 +1,6 @@ --- name: Anything else -about: File any other type of issue you have +about: File any other type of issue title: '' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c5e934d7..6172a1df 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Let us know about a bug you have found +about: Let us know about a bug title: '' labels: bug assignees: '' @@ -8,16 +8,24 @@ assignees: '' --- **Describe the bug** -Provide us with clear and concise description of what the bug is. + +As clearly as you can, please tell us what the bug is. **To Reproduce** -Provide us with specific steps to reproduce the behavior. In most cases, we should be able to copy and paste these steps to reproduce the issue you are seeing. In a perfect world, this would look like: -```go -mkdir tmp -cd ./tmp + +Help us to reproduce the buggy behavior. Ideally, you'd provide a +self-contained test that shows us the bug: + +```bash +mkdir tmp && cd ./tmp go mod init example go get github.com/bufbuild/connect-go -cat < bug_report_test.go +touch example_test.go +``` + +And in `example_test.go`: + +```go package bugreport func TestThatReproducesBug(t *testing.T) { @@ -26,8 +34,12 @@ func TestThatReproducesBug(t *testing.T) { ``` **Environment (please complete the following information):** -- `connect-go` version or commit: [e.g. `v0.1.0` or `5bfc7a1b440ebffdc952d813332e3617ca611395`] - - `go version`: [e.g. `go version go1.18.3 darwin/amd64`] +- `connect-go` version or commit: (for example, `v0.1.0` or `5bfc7a1b440ebffdc952d813332e3617ca611395`) +- `go version`: (for example, `go version go1.18.3 darwin/amd64`) +- your complete `go.mod`: + +```go +``` **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e52c44bb..0d336754 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Suggest an new feature or improvement +about: Suggest a new feature or improvement title: '' labels: enhancement assignees: '' @@ -8,13 +8,14 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +What's the problem? For example, "I'm always frustrated when..." **Describe the solution you'd like** -A clear and concise description of what you want to happen. +What would you like to have `connect-go` do? How should we solve the problem? **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +If you've proposed a solution, are there any alternatives? Why are they worse +than your preferred approach? **Additional context** Add any other context or screenshots about the feature request here.