hackforla / hackforla/website

Create issue template "Resolve Spell Check warning"

Open
#6,446 7 comments 0 reactions 0 assignees View on GitHub
Complexity: Small Dependency feature: spelling HLC: S ready for dev lead role: back end/devOps size: 0.5pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Dependency
- [x] #6519
- [ ] #5312

### Overview
We need a template for reporting spell check warnings, so that we can create issues to address.

### 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 the instructions for testing the new template and preparing the Pull Request. [^1]

### 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 instructions on "How to manage spell check warnings" (resource 1)
- [ ] 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
1. [draft: How to manage spell check warnings](https://github.com/hackforla/website/issues/6519#issuecomment-2021279777)
2. [Code Spell Checker](https://streetsidesoftware.com/vscode-spell-checker/)
3. [Introduction to JSON](https://www.json.org/json-en.html)
---
```

### Resources
[^1]:[Testing issue templates instructions](https://github.com/hackforla/website/issues/4786#issuecomment-1670584024)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.