Create a wiki page for linters used by the HfLA website team
- Dominant language
- JavaScript
- Stars
- 363
- Forks
- 872
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 18
Description
# Dependency
- #1442
- #2651
- #3636
### Overview
As a developer, I would like critical processes to be documented in a wiki page. In this issue, we will create a wiki page with details about how linters are being used in our repo.
### Action Items
- [ ] Explore how [wiki pages](https://github.com/hackforla/website/wiki) are organized in our repo.
- [ ] Decide which section would be appropriate for this new wiki page.
- [ ] Understand linter architecture in the following document: [GHA architecture notes spreadsheet](https://docs.google.com/spreadsheets/d/12NcZQoyGYlHlMQtJE2IM8xLYpHN75agb/edit#gid=1231634015)
- [ ] Create a new wiki page and include a brief section on how linters work in general.
- [ ] List all the linters being used in our repo as well as the workflows related to linters. For example: [Lint SCSS](https://github.com/hackforla/website/blob/gh-pages/.github/workflows/lint-scss.yml)
- [ ] For each linter, add the following information:
- [ ] When does the workflow get triggered
- [ ] Discuss a workflow scenario and next steps for when the linter catches an error.
- [ ] Discuss a workflow scenario for when the linter runs with no error.
- [ ] Since no PR would be needed for this issue, once all action items are done, reach out to the leads or merge team members for a review.
### Resources/Instructions
- [GHA architecture notes spreadsheet](https://docs.google.com/spreadsheets/d/12NcZQoyGYlHlMQtJE2IM8xLYpHN75agb/edit#gid=1231634015)
- [HackforLA.org (HfLA) Website Wiki](https://github.com/hackforla/website/wiki)
Contributor guide
Assessment
This issue has not been assessed yet.