Skip to content

Commit 4d2b6a6

Browse files
committed
style: update contribution documentation for clarity and formatting
- Changed section headers for "Experience" and "Recognition" to improve visibility. - Removed strikethrough from the integration testing guideline to clarify its importance. - Minor formatting adjustments for consistency and readability.
1 parent 0dd95f5 commit 4d2b6a6

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

docs/contribute/contribute.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ If these goals align with your own, we'd love to work with you!
1717

1818
### What's in it for you
1919

20-
🚀 **Experience**
20+
#### 🚀 Experience
2121

2222
Working on Compass gives you unique experience that you won't get anywhere else.
2323

24-
**Meritocracy**: Compass operates on outputs, not resumes or locales. An Ex-Googler in SF gets the same treatment as someone in Mongolia who just learned HTML; We only care about the quality of the work you can produce.
24+
- **Meritocracy**: Compass operates on outputs, not resumes or locales. An Ex-Googler in SF gets the same treatment as someone in Mongolia who just learned HTML; We only care about the quality of the work you can produce.
2525

26-
**Fullstack**: Since this is an open-source monorepo, you can get experience getting things to work end-to-end without silos. This'll help you become a true fullstack engineer.
26+
- **Fullstack**: Since this is an open-source monorepo, you can get experience getting things to work end-to-end without silos. This'll help you become a true fullstack engineer.
2727

28-
**Transparency**: Code isn't the only thing that we're transparent about. We publish our [handbook](https://compasscalendar.notion.site/), roadmap, technical guides, and lessons-learned across our repos and social media. Working in an open culture will give you more opportunities to grow as an engineer and leader.
28+
- **Transparency**: Code isn't the only thing that we're transparent about. We publish our [handbook](https://compasscalendar.notion.site/), roadmap, technical guides, and lessons-learned across our repos and social media. Working in an open culture will give you more opportunities to grow as an engineer and leader.
2929

30-
🏆 Recognition (GitHub, changelogs, etc)
30+
#### 🏆 Recognition
3131

3232
What may be offered after consistent excellence\*:
3333

docs/contribute/testing-guide.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,22 @@
22

33
This doc explains how to write tests during development. For information on running tests, see the [Testing Guide](../guides/test.md).
44

5-
## Write tests. Mostly unit. ~~Some integration.~~
5+
## Write tests. Mostly unit. Some integration.
66

77
Tests should be
88

99
1. **Understandable**: It should be relatively easy for a newcomer to read the tests, understand their intent, make changes, and write similar tests
1010
2. **Focused**: The view should be decoupled/abstracted from the test as much as possible. The tests should work whether we're snapping on a 7 day week, a 4 day week, or a day view. Minimal changes and setup are acceptable, but out tests and implementation shouldn't be tightly connected to our current view.
1111
3. **Mostly unit**: Since our UI is going to change frequently, let's just focus on the logic. No need to write interaction or e2e tests for these. Those'll come in a separate effort.
12-
4. ~~**Some integration**: If you're testing a feature that spans multiple units, it's okay to write an integration test. But try to keep it to a minimum. We want to keep our tests fast and focused.~~
13-
> Integration tests aren't a priority currently.
12+
4. **Some integration**: If you're testing a feature that spans multiple units, it's okay to write an integration test.
1413

1514
## Test Manually
1615

17-
This is an important part of the PR process. We manually test every PR in a local environment, staging environment, and the production environment. If we find bugs during this manual testing, we'll have to create new bug issues, ask you for revisions, or reject the PR entirely.
16+
This is an important part of the PR process. We manually test every PR in a local environment, staging environment, and the production environment. If we find bugs during this manual testing, we'll have to create new bug issues, ask you for revisions, or reject the PR entirely.
1817

19-
Just because the automated tests are passing does not mean the PR is ready to be merged.
18+
Just because the automated tests are passing does not mean the PR is ready to be merged.
2019

2120
Give your PR the highest likelihood of being accepted by thoroughly testing it and looking for bugs.
2221

2322
Because the app is so connected to one view, it's important to test all of its capabilities to ensure that your change didn't break anything else.
24-
If you updated how an event is dragged, for example, make sure to test drag and dropping as well. If you changed how timed events are displayed, also test that all-day events and sidebar events still work.
23+
If you updated how an event is dragged, for example, make sure to test drag and dropping as well. If you changed how timed events are displayed, also test that all-day events and sidebar events still work.

0 commit comments

Comments
 (0)