Create issue template "Resolve Spell Check warning"

roslynwythe commented 4 months ago

Overview

We require a template for reporting spell check warnings

Dependency

[ ] #6519

Action Items

[ ] Create a new file .github/ISSUE_TEMPLATE/spellcheck-warning.md
[ ] Copy/Paste the text below into the file, then save it
[ ] Refer to these instructions for testing the new template and preparing the Pull Request.

Content of issue template

---
name: Resolve spell check warning
about: For reporting spell check warnings ("unknown word")
title: 'Resolve spell check warning(s) in: [replace with file path] '
labels: 'good first issue, feature: spelling, role: back end/devOps , size: 0.25pt'
assignees: ''

---

### Overview
We need to manage the warnings ("unknown word") generated by spell check

### Action Items
- [ ] Open the file `[REPLACE WITH FILE PATH]` in your IDE
- [ ] Refer to the wiki page "How to manage spell check warnings" or if that has not been published yet, see [draft: How to manage spell check warnings](https://github.com/hackforla/website/issues/6519#issuecomment-2021279777)
- [ ] Copy the block "Resolving spell check warnings" into a new comment in this issue, then select the green Comment button to create the comment. Follow the instructions in the comment you just created.

### Resources/Instructions
[Introduction to JSON](https://www.json.org/json-en.html)
[Code Spell Checker](https://streetsidesoftware.com/vscode-spell-checker/)
[draft: How to manage spell check warnings](https://github.com/hackforla/website/issues/6519#issuecomment-2021279777)

[^1]: [Installing Code Spell Checker from the VS Code text editor](https://code.visualstudio.com/learn/get-started/extensions)
[^2]:[Code Spell Checker - VS Marketplace](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)

---

github-actions[bot] commented 4 months ago

Hi @roslynwythe.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

Complexity, Role, Feature, Size

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

roslynwythe commented 4 months ago

@ExperimentsInHonesty Would you prefer that the instructions for managing spell check errors are presented in a wiki page, and this issue could refer to that page? I think we will need such a wiki page, and we might run into discrepancies if they are also presented in the action items in this issue.

ExperimentsInHonesty commented 4 months ago

@roslynwythe I definitely think that its easier if the instructions are on a wiki page. That way the issue is always as fresh as the wiki page is. In that case the wiki page would need to have a copy block and the instructions on the issue template would be to customize the issue with the task items from the wiki. See example Issue template that asks you to get todo items from wiki wiki page: https://github.com/hackforla/admin-calendaring/wiki/Update-Team-Calendar

But also, how often do you think we change the template?

ExperimentsInHonesty commented 3 months ago

@roslynwythe I thought we were going to link to the wiki for instructions on how to do things, did that end up being unnecessary?

roslynwythe commented 3 months ago

@ExperimentsInHonesty It's tricky to reference a wiki page now because we don't have a permanent link so I wrote

 "Refer to the wiki page "How to manage spell check warnings" or if that has not been published yet, see [draft: How to manage spell check warnings](https://github.com/hackforla/website/issues/6519#issuecomment-2021279777)

Hopefully that is clear.

hackforla / website