Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ann-kilzer authored Apr 24, 2024
1 parent ae59ecc commit aa8750a
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# ✨ Welcome ✨




## MVP Phase 🌱

- We are only accepting changes from core team members at this phase. Thanks for your understanding
Expand All @@ -11,20 +9,30 @@
- Clear communication with our bilingual community (EN/JA)
- a11y to ensure inclusion
- leveraging automation to ensure quality and developer experience (e.g. gitHub actions is our friend)
- Responsive design
- keeping it simple

## Tech Stack ⭐
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/
- This project is set up with eslint for both style and code checking
- This project is set up with eslint for both style and code checking 🧹

## PR Requirements ☑️
## 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.
- All GH Actions should pass
- Branch name should start with the ticket number, e.g. `11-dns-setup`
- Please write unit tests for new enhancements
- Please write unit tests for new enhancements 🧪

## PR Guidelines
- All GH Actions should pass ☑️
- No force pushing to branches ❌
- Avoid adding arbitrary whitespace
- Separate logical changes from style changes
- Avoid adding arbitrary whitespace ❌
- Separate logical changes from style changes 🔪
- Try to keep PRs under 500 lines of code 🤏
- Making multiple PRs to solve a single issue is okay! 🙆🏻‍♀️


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

0 comments on commit aa8750a

Please sign in to comment.