]> Cypherpunks repositories - gostls13.git/commitdiff
.github: improve formatting of the telemetry proposal template
authorRobert Findley <rfindley@google.com>
Tue, 7 May 2024 18:52:46 +0000 (14:52 -0400)
committerRobert Findley <rfindley@google.com>
Tue, 7 May 2024 19:58:26 +0000 (19:58 +0000)
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>
.github/ISSUE_TEMPLATE/12-telemetry.yml

index 5524659136625f8d39821b8e8db8de3cba83176f..e072df260aaf634d490c178bca095d4e8429a6a4 100644 (file)
@@ -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.