Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
update contributing instructions
  • Loading branch information
ann-kilzer authored Jul 6, 2024
1 parent 3ded3fe commit 20511d3
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@
I've set us up with a modern frontend tech stack so that we can practice together. This includes TypeScript, which has a bit of a learning curve.

## Best Practices
- Use Editorconfig to match expected style: https://editorconfig.org/
- Use Editorconfig to match expected style: https://editorconfig.org/ (If you are a VSCode user this means installing an extention)
- This project is set up with eslint for both style and code checking 🧹
- Please disable Prettier plugins in your editor ([VSCode instructions](https://stackoverflow.com/a/75471109/1860768))

## Working on an Issue ☑️
- Please assign yourself to any ticket you are working on. Please unassign yourself if you aren't able to move it forward. Feel free to ask for help if you get stuck.
- Branch name should start with the ticket number, e.g. `11-dns-setup`
- Please write unit tests for new enhancements 🧪
- Please write unit and E2E tests for new enhancements 🧪

## PR Guidelines
- All GH Actions should pass ☑️
Expand All @@ -32,6 +33,12 @@ I've set us up with a modern frontend tech stack so that we can practice togethe
- Try to keep PRs under 500 lines of code 🤏
- Making multiple PRs to solve a single issue is okay! 🙆🏻‍♀️

## Testing Guidelines
- Unit tests have coverage metrics. 60 - 80% coverage is good ⭐
- Try to approach writing tests the way a real user would interact with the site. [See Guiding Principles from Testing Library](https://testing-library.com/docs/guiding-principles/)
- Rather than adding test ids, we prefer semantic selectors like `getByRole`, `getByLabel`, or `getByText`
- Playwright is great for testing complex interactions across components or pages.


## Merging
- Merging to main triggers a deploy to production. Please check that the site deploys correctly
Expand Down

0 comments on commit 20511d3

Please sign in to comment.