aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorRobert Findley <rfindley@google.com>2024-05-07 14:52:46 -0400
committerRobert Findley <rfindley@google.com>2024-05-07 19:58:26 +0000
commit9c5269c2530162fd898e81c3eb12b98cef01d6a5 (patch)
treeee8893e616ea7152a01ba4bcb81aa5905a4a5299 /.github/ISSUE_TEMPLATE
parent5f5e9f4ff1c855e88474f007043863093fff40cc (diff)
downloadgo-9c5269c2530162fd898e81c3eb12b98cef01d6a5.tar.gz
go-9c5269c2530162fd898e81c3eb12b98cef01d6a5.zip
.github: improve formatting of the telemetry proposal template
Tweak the new telemetry proposal template added in CL 583496: - Shorten the description, as it is formatted on one conspicuously long line in the template picker. - Use folded style for label descriptions, as their line breaks cause the resulting paragraph to flow awkwardly. Change-Id: I3089ac0717646e153765548d4bebd8d4751933b2 Reviewed-on: https://go-review.googlesource.com/c/go/+/583916 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Alan Donovan <adonovan@google.com>
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/12-telemetry.yml9
1 files changed, 3 insertions, 6 deletions
diff --git a/.github/ISSUE_TEMPLATE/12-telemetry.yml b/.github/ISSUE_TEMPLATE/12-telemetry.yml
index 5524659136..e072df260a 100644
--- a/.github/ISSUE_TEMPLATE/12-telemetry.yml
+++ b/.github/ISSUE_TEMPLATE/12-telemetry.yml
@@ -1,7 +1,5 @@
name: Go Telemetry Proposals
-description: |
- Modify the telemetry upload configuration, by adding new counters to upload,
- or refining or removing existing upload configuration.
+description: Changes to the telemetry upload configuration
title: "x/telemetry/config: proposal title"
labels: ["Telemetry-Proposal"]
projects: ["golang/29"]
@@ -9,11 +7,10 @@ body:
- type: textarea
attributes:
label: Summary
- description: |
+ description: >
What change are you proposing to the upload configuration, and why?
For new upload configuration, which new counters will be collected, what
do they measure, and why is it important to collect them?
- All counters must already be instrumented in the target program.
Note that uploaded data must not carry sensitive user information.
See [go.dev/doc/telemetry#proposals](https://go.dev/doc/telemetry#proposals)
for more details on telemetry proposals.
@@ -22,7 +19,7 @@ body:
- type: input
attributes:
label: Proposed Config Change
- description: |
+ description: >
A CL containing proposed changes to the
[config.txt](https://go.googlesource.com/telemetry/+/master/internal/chartconfig/config.txt)
chart configuration.