|
4 | 4 |
|
5 | 5 | We're laser-focused on two things: |
6 | 6 |
|
7 | | -1. Helping minimalists manage their schedule and focus, so they can do more of what matters |
| 7 | +1. Helping minimalists manage their schedule, so they can do more of what matters |
8 | 8 | 2. Being profitable, so that we can continue doing #1 for decades |
9 | 9 |
|
10 | | -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 quarterly backlog, timeline, and app docs in the main Compass repo (more links and details on how to do this below). |
| 10 | +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 quarterly backlog and docs in the main Compass repo (more links and details on how to do this below). |
11 | 11 |
|
12 | 12 | If these goals align with your own, we'd love to work with you! |
13 | 13 |
|
@@ -49,13 +49,13 @@ What may be offered after consistent excellence\*: |
49 | 49 | 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. |
50 | 50 | 1. Find an issue you'd like to work on. |
51 | 51 | 1. Ask any clarifying questions in the issue thread. |
52 | | -1. Start working on the issue. If you're a new contributor, we will NOT assign the issue to you before a PR is submitted. This helps us avoid holding an issue for an extended period of time. |
| 52 | +1. Start working on the issue. Do not request that an issue be assigned to you. If you're a new contributor, we will NOT assign the issue to you before a PR is submitted. This helps us avoid holding an issue for an extended period of time. |
53 | 53 | 1. Fork the repository |
54 | 54 | 1. Create a new branch with a descriptive name |
55 | 55 | 1. Make your changes, following the coding conventions |
56 | 56 | 1. Manually test your changes. See the testing guide for more info on how to do this sufficiently. |
57 | 57 | 1. Push your branch to your fork |
58 | | -1. Create a pull request |
| 58 | +1. Create a pull request, including screenshots/video documenting the behavior. Also explain the steps you took to manually verify the functionality. Blindly submitting AI-generated code without showing evidence of thorough testing will result in the PR being denied. |
59 | 59 | 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` |
60 | 60 | 1. Wait for us to review the PR. You can continue this process with another issue while waiting for feedback. |
61 | 61 |
|
@@ -257,6 +257,7 @@ test(web): add unit tests for login component |
257 | 257 | ``` |
258 | 258 |
|
259 | 259 | 5. **Generate Documentation** (if you added/modified APIs) |
| 260 | + |
260 | 261 | ```bash |
261 | 262 | bun run docs:generate |
262 | 263 | ``` |
|
0 commit comments