hackforla / hackforla/311-data

Epic: Testing and Code Coverage

Open
#1,768 1 comment 0 reactions 1 assignee Claimed by @rayneng View on GitHub
Complexity: Small Epic Feature: Code Health Feature: Documentation Role: Frontend size: 0.25pt
Dominant language
JavaScript
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

### Overview

We need to implement a frontend testing framework for our project so we can prevent bugs and regressions, as well as provide a means of teaching other volunteers how to utilize testing to improve their code

### Action Items
Testing
- [x] https://github.com/hackforla/311-data/issues/1778
- [x] https://github.com/hackforla/311-data/issues/1824
- [x] https://github.com/hackforla/311-data/issues/1823
- [x] https://github.com/hackforla/311-data/issues/1839
- [x] https://github.com/hackforla/311-data/issues/1834
- [x] https://github.com/hackforla/311-data/issues/1334
- [ ] create a ticket template for unit and integration tests
- [ ] and create a unit test as an example
- [ ] create an integration test as an example
- [ ] create wiki page for testing
- [ ] include some basic definitions for testing terminology
- [ ] list our testing tools
- [ ] how to utilize unit/integration test template
- [ ] set up CI for tests to run on every PR made to `main` branch
- [ ] branches are blocked from merge until all tests pass
- [ ] add to PR checklist to add test to cover any newly added feature
- [ ] create tickets for each documented user flow in Figma (live-forever ticket)

Unused Code
- [ ] ER: consider code coverage tool that (e.g. VS Code plugin) that determines which components are actually being used
- credit: @DrAcula27

### Resources
- [Testing Folder File Structure](https://www.briefs.fm/3-minutes-with-kent/118)
- Discussion around how to approach implementation of frontend framework
- Andrew's initial analysis for testing in 311 Data: [link to comment](https://github.com/hackforla/311-data/issues/1334#issuecomment-2159161532)
- Andrew's note on how to approach testing despite heavy use of canvas element: [link to comment](https://github.com/hackforla/311-data/issues/1334#issuecomment-2168384653)

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.