Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve user-facing label action comments #21322

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions .github/label-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
Hi there,


We have found that there's a problem with the logs.
We found a problem with the logs.
Depending on which situation applies follow one, some or all of these instructions.


Expand Down Expand Up @@ -95,6 +95,12 @@

</details>


Good luck,


The Renovate team

'new package manager':
comment: >
Hi there,
Expand Down Expand Up @@ -133,11 +139,17 @@


You're skipping code tests with `istanbul ignore`.


Please only skip tests if:
- you cannot test the code, or
- the code is very difficult to test, or
- the edge case won't usually happen at runtime
If you skip a test then always comment why:


If you skip a test, always comment why:


```ts
// istanbul ignore next: typescript strict null check
if (!url) {
Expand Down Expand Up @@ -175,19 +187,24 @@
comment: >
**Please create a GitHub Discussion instead of this issue.**


As this issue has been labeled as `needs-discussion` by a maintainer it is being automatically closed and locked. It will later be deleted to avoid polluting repository searches with duplicate or incorrect content.


This doesn't necessarily mean that what you've reported isn't a problem or a reasonable idea, but it does mean that it should be raised as a Discussion first and not an Issue. Please create a Discussion now, assuming you still wish to discuss it.


Thanks, The Renovate team
close: true
lock: true
lock-reason: 'resolved'

'needs-code-formatting':
comment: >
Hi, you need to format code or logs here so that they're more readable for others.
Hi, please format your code or logs so they're readable.


You can find a Markdown code formatting guide [here](https://www.markdownguide.org/basic-syntax/#code) as well as some GitHub-specific information formatting code blocks [here](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).


Thanks, The Renovate team