You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update Docusaurus configuration and documentation for clarity and consistency
- Changed the tagline in docusaurus.config.js to reflect the updated focus on the task manager for engineers.
- Replaced the hardcoded handbook URL with a constant imported from src/constants.js for better maintainability.
- Deleted the outdated roadmap.md file and created a new roadmap.mdx file linking to the handbook for improved accessibility.
- Added a new contribute.mdx file outlining contribution guidelines and expectations, emphasizing alignment with project goals.
- Introduced src/constants.js to centralize external URLs and constants.
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
**ALWAYS follow these instructions first.** Only fallback to additional search and context gathering if the information in these instructions is incomplete or found to be in error.
4
4
5
-
Compass Docs is a Docusaurus v3.x documentation site for the Compass calendar application. It provides comprehensive documentation for developers and users of the open-source calendar for minimalists.
5
+
Compass Docs is a Docusaurus v3.x documentation site for the Compass task manager. It provides comprehensive documentation for developers and users of the open-source task manager for engineers.
@@ -11,42 +13,42 @@ We're laser-focused on two things:
11
13
1. Helping minimalists manage their schedule and focus, so they can do more of what matters
12
14
2. Being profitable, so that we can continue doing #1 for decades
13
15
14
-
We're only accepting contributions that help us reach those goals. If you submit a PR that doesn't align with our goals, it will be rejected. The best way to avoid this scenario is to confirm that your proposed changes align with our priorities. You can verify this by reviewing the [Roadmap](../roadmap.md) and timeline (more links and details on how to do this below).
16
+
We're only accepting contributions that help us reach those goals. If you submit a PR that doesn't align with our goals, it will be rejected. The best way to avoid this scenario is to confirm that your proposed changes align with our priorities. You can verify this by reviewing the [Roadmap](../roadmap.mdx) and timeline (more links and details on how to do this below).
15
17
16
18
If these goals align with your own, we'd love to work with you!
17
19
18
20
### What's in it for you
19
21
20
-
#### 🚀 Experience
22
+
#### Experience
21
23
22
24
Working on Compass gives you unique experience that you won't get anywhere else.
23
25
24
26
-**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.
25
27
26
28
-**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.
27
29
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.
30
+
-**Transparency**: Code isn't the only thing that we're transparent about. We publish our <ahref={HANDBOOK_URL}target="_blank"rel="noopener noreferrer">handbook</a>, 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.
29
31
30
-
#### 🏆 Recognition
32
+
#### Recognition
31
33
32
34
What may be offered after consistent excellence\*:
33
35
34
-
-📝 Reference for your next job
35
-
-📈 Compensation
36
-
-📈 Preference for future opportunities @ Switchback (the company behind Compass)
36
+
- Reference for your next job
37
+
- Compensation
38
+
- Preference for future opportunities @ Switchback (the company behind Compass)
37
39
38
40
\*These are the criteria we use to assess the quality of your work. If you don't meet these criteria, we may reject your PR.
39
41
40
42
1.**Code quality**: Is the code readable, well-organized, and testable? Does it follow best practices? Does it provide good UX?
41
-
2.**Expertise**: Does your work reflect your skill level? Did you need a lot of technical guidancein order toget started? Were you able to make good judgments about the requirements and implementation?
42
-
3.**Communication**: If you got blocked, did you reach out for help?Did you communicate your plans and progress clearly?Are your commits, PR descriptions, and comments easy to understand?
43
+
2.**Expertise**: Does your work reflect your skill level? Did you need a lot of technical guidancein order toget started? Were you able to make good judgments about the requirements and implementation?
44
+
3.**Communication**: If you got blocked, did you reach out for help?Did you communicate your plans and progress clearly?Are your commits, PR descriptions, and comments easy to understand?
43
45
4.**Reliability**: Did you submit your PR, update based on comments in a timely manner? If something came up that prevented you from completing a PR on time, did you let us know?
44
46
45
47
## Workflows
46
48
47
-
### 🏁 You're ready to pick up a new task
49
+
### You're ready to pick up a new task
48
50
49
-
1. Review the [roadmap](../roadmap.md) to confirm that the issue you'd like to work on is aligned with our goals
51
+
1. Review the [roadmap](../roadmap.mdx) to confirm that the issue you'd like to work on is aligned with our goals
50
52
1. Review [the quarterly backlog](https://github.com/orgs/SwitchbackTech/projects/4/views/8). This is the view that shows each important issue by the quarter it's planned for.
51
53
1. Review [the timeline](https://github.com/orgs/SwitchbackTech/projects/4/views/7) to confirm that you could finish the issue you'd like to work on before its deadline.
52
54
1. If this is your first time contributing, pick an issue in the `Ready` state for the _next_ quarter that has a `Good first issue` tag. Working on an issue in the next quarter gives you time to familiarize yourself with the codebase while still working on a priority change. It also gives us the chance to assess the quality of work and your reliability before giving you more responsibility.
@@ -62,16 +64,16 @@ What may be offered after consistent excellence\*:
62
64
1. Link the PR to the issue it solves by including the issue number in the PR description and using a [closing keyword](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue). For example: `Fixes #123`
63
65
1. Wait for feedback. You can continue this process with another issue while waiting for feedback.
64
66
65
-
### 🐞 You found an undocumented bug
67
+
### You found an undocumented bug
66
68
67
69
- If the bug is a security vulnerability, please [report it here](https://github.com/SwitchbackTech/compass/security).
68
70
- Ensure the bug was not already reported by searching under the issues
69
71
- If it's a new bug, open a new issue, including as much relevant information as possible.
70
72
71
-
### ☝️ You want to add a new feature or dramatically change an existing one
73
+
### You want to add a new feature or dramatically change an existing one
72
74
73
-
Larger features or changes that are not already on our [Roadmap](../roadmap.md) or in the backlog will most likely be rejected. If you're unsure, open a GitHub issue before you start working. This will help ensure that your work is aligned with the project's goals and that you don't spend time on something that won't be prioritized.
75
+
Larger features or changes that are not already on our [Roadmap](../roadmap.mdx) or in the backlog will most likely be rejected. If you're unsure, open a GitHub issue before you start working. This will help ensure that your work is aligned with the project's goals and that you don't spend time on something that won't be prioritized.
74
76
75
-
### 💅 You fixed whitespace, formatted code, or made a purely cosmetic patch
77
+
### You fixed whitespace, formatted code, or made a purely cosmetic patch
76
78
77
79
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted.
0 commit comments