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

Update GH issue template for reporting issues with lessons #4066

Open
3 of 6 tasks
JustWaveThings opened this issue Aug 4, 2023 · 5 comments
Open
3 of 6 tasks

Update GH issue template for reporting issues with lessons #4066

JustWaveThings opened this issue Aug 4, 2023 · 5 comments
Assignees
Labels
Status: Needs Review This issue/PR needs an initial or additional review

Comments

@JustWaveThings
Copy link
Contributor

Complete the following REQUIRED checkboxes:

  • I have thoroughly read and understand The Odin Project Contributing Guide

  • The title of this issue follows the brief description of request format, e.g. Add dark mode to website

The following checkbox is OPTIONAL:

  • I would like to be assigned this issue to work on it

1. Description of the Feature Request:

When following the link 'Report a problem' from a lesson(see #4057), it brings the user to an issue template that makes it seem that it is a good place to give a suggestion. See screenshot:
image
example link: https://github.com/TheOdinProject/curriculum/issues/new?assignees=nil&labels=Status%3A+Needs+Triage&projects=&template=suggestion.yaml&title=Setting%20up%20Git%3A+%3CShort+description+of+your+suggestion%3E

2. Acceptance Criteria:

  • Explains the purpose of this issue template is to gather feedback about things that need to be reported, like a broken link or objectionable content, etc.
  • Provides information and link to the curriculum repo discussion's feature, with advice to first see if someone else has made the same suggestion previously.
  • Rework the checks section to make it clear that one doesn't need to read the contributing guide if they don't want to be assigned the issue, but that they would need to if they want to be assigned the issue.

3. Additional Information:

I brought up the ambiguity of the form's purpose to Kevin when trying to name the link for 'Report an issue', and he stated that we'd want to push suggestions to the discussions feature and let the form be there to collect reports, and would probably want to update the form to make that clear.

@JustWaveThings JustWaveThings added the Status: Needs Review This issue/PR needs an initial or additional review label Aug 4, 2023
@Asartea
Copy link
Contributor

Asartea commented Aug 5, 2023

I think this issue should be filed against https://github.com/TheOdinProject/curriculum ? Thats where this template resides

@JustWaveThings
Copy link
Contributor Author

Thanks @Asartea. I see that now.

@JustWaveThings JustWaveThings closed this as not planned Won't fix, can't repro, duplicate, stale Aug 5, 2023
@JustWaveThings JustWaveThings reopened this Aug 5, 2023
@JustWaveThings
Copy link
Contributor Author

While the template lives in the curriculum repo, it doesn't feel like a good place for this issue, at least to me. I reopened this issue here. I am new to collaborating on GH so any help would be appreciated. :)

@ManonLef
Copy link
Member

ManonLef commented Aug 5, 2023

We can always transfer issues as needed so don't worry about it :)

@ManonLef
Copy link
Member

ManonLef commented Aug 5, 2023

TheOdinProject/curriculum#26054 for more inspiration on updating

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review
Projects
Status: 📋 Backlog / Ideas
Development

No branches or pull requests

4 participants