theodinproject
theodinproject copied to clipboard
Update GH issue template for reporting issues with lessons
Complete the following REQUIRED checkboxes:
-
[x] I have thoroughly read and understand The Odin Project Contributing Guide
-
[x] The title of this issue follows the
brief description of request
format, e.g.Add dark mode to website
The following checkbox is OPTIONAL:
- [x] 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:
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.
I think this issue should be filed against https://github.com/TheOdinProject/curriculum ? Thats where this template resides
Thanks @Asartea. I see that now.
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. :)
We can always transfer issues as needed so don't worry about it :)
https://github.com/TheOdinProject/curriculum/issues/26054 for more inspiration on updating