chore: update outline-client issue templates #1696
Conversation
Help users understand when to contact support vs. when to submit issues in GitHub, and direct developers to the Discussion board for the SDK.
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #1696 +/- ##
======================================
Coverage 36% 36%
======================================
Files 45 45
Lines 2749 2749
Branches 312 312
======================================
Hits 1006 1006
Misses 1743 1743
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Creating a new "support request" template to direct users who have support needs away from creating a new issue.
Directing people with questions away from submitting issues.
maddyhof
changed the title
There was a problem hiding this comment.
I'm approving as this is valid markdown, but I would encourage you to try to figure out how to write a .github/ISSUE_TEMPLATE/config.yml so we can replace some of these issue templates with direct links in the template chooser. See here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| The issue tracker is not for questions. Please ask questions at [email protected]. | ||
| The issue tracker is not for questions. |
There was a problem hiding this comment.
I think this could actually be replaced with a link!
| --- | ||
| The issue tracker is not for support requests. | ||
|
|
||
| If you would like support with Outline Manager or Outline Client, please review the help articles on [support.getoutline.org](https://support.getoutline.org/), and [contact us](https://support.getoutline.org/s/contactsupport) if you need further assistance. Developers, please post your questions on the SDK [Discussion board](https://github.com/Jigsaw-Code/outline-sdk/discussions). |
There was a problem hiding this comment.
This template could also be replaced with a link!
Also, check out the SUPPORT.md file: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project
There was a problem hiding this comment.
There are a number of files we should probably create in the name of community health: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
There was a problem hiding this comment.
Since there are 3 separate places to direct people, I couldn't think of a single link that would suffice. What did you have in mind?
There was a problem hiding this comment.
We could just list the three links directly in the template chooser!
There was a problem hiding this comment.
Since these are the set of template changes we agreed to in the doc, are you comfortable with us implementing them as written and then we can always iterate on them going forward?
There was a problem hiding this comment.
Yep! That's why I approved it. Feel free to merge!
Help users understand when to contact support vs. when to submit issues in GitHub, and direct developers to the Discussion board for the SDK.