Refactor education & work history front-end code
Open
Nobody has claimed this yet.
Tech Debt
- Dominant language
- Python
- Stars
- 32
- Forks
- 17
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 4
Description
Two main issues:
- Education and work history inputs share a ton of behavior as well as look and feel, but they've been developed in parallel with significant copying/pasting, but very different implementation patterns (some of this is remedied in PR #1005). We should abstract the common behavior and design to a common component, and refactor some of the unit tests
- EducationForm.js and EducationDisplay.js also share a significant amount of copyied/pasted code, which leaves us vulnerable to some bugs (example: implementing features on the Education signup page and not implementing the same features on the Education section of the user page). The behavior and design that we want to remain consistent between these two sections should be shared, not copied
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing EducationForm.js and EducationDisplay.js, then compare the education and work history implementations and the changes in PR #1005. The refactor is complete when shared behavior and design use common components rather than copied code, and the affected unit tests are updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100