Skip to content

Commit b8f7314

Browse files
committed
Update contribution guide and add contribute link to navbar
1 parent c375d21 commit b8f7314

4 files changed

Lines changed: 46 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing! We welcome help in two areas.
4+
5+
## Improve the docs
6+
7+
Doc improvements are a great way to get started—typos, broken links, clearer explanations, new examples.
8+
9+
1. Use **Edit this page** on any doc (at the bottom of each page on [docs.compasscalendar.com](https://docs.compasscalendar.com))
10+
2. Open a PR to this repository (compass-docs)
11+
3. Run the doc site locally to verify: `yarn` then `yarn start`
12+
13+
Doc PRs don't need full Compass app setup. Just ensure the site builds and renders (`yarn build`).
14+
15+
Full details: [How to Contribute - Improve the Docs](https://docs.compasscalendar.com/docs/contribute#improve-the-docs)
16+
17+
## Contribute to the Compass app
18+
19+
For code, features, and bug fixes to the Compass application itself, see the [contribute section](https://docs.compasscalendar.com/docs/contribute) in our docs. You'll find workflows, coding conventions, and how to find good first issues.

docs/contribute/contribute.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,24 @@ What may be offered after consistent excellence\*:
4444
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?
4545
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?
4646

47-
## Workflows
47+
## Improve the Docs
48+
49+
Doc improvements are valued and often the best first step—no need to run the full Compass app. We welcome typo fixes, broken links, clearer explanations, new examples, and outdated screenshots.
50+
51+
1. Use **Edit this page** on any doc (link at the bottom of each page)
52+
2. Open a PR to [compass-docs](https://github.com/SwitchbackTech/compass-docs)
53+
3. Run the doc site locally with `yarn` and `yarn start` to verify your changes—no need to set up the Compass app
54+
55+
Doc PRs don't need full app testing. Just ensure the site builds and renders correctly (`yarn build`).
56+
57+
## Find Something to Work On
58+
59+
- [Good first issues for Compass](https://github.com/SwitchbackTech/compass/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) — app contributions
60+
- [compass-docs issues](https://github.com/SwitchbackTech/compass-docs/issues) — doc improvements, typos, and clarity
61+
62+
## Workflows (Compass App)
63+
64+
The following workflows apply when contributing to the **Compass app** (code, features, bug fixes). For doc changes, use the [Improve the Docs](#improve-the-docs) path above.
4865

4966
### You're ready to pick up a new task
5067

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ const config = {
8787
label: "Get Started",
8888
},
8989
{ to: "/blog/about", label: "About", position: "left" },
90+
{ to: "/docs/contribute", label: "Contribute", position: "left" },
9091
],
9192
},
9293
footer: {

src/pages/index.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,14 @@ function HomepageHeader() {
1919
className="button button--secondary button--lg"
2020
to="/docs/get-started/setup"
2121
>
22-
Get Started - 23 min ⏱️
22+
Get Started
23+
</Link>
24+
<Link
25+
className="button button--outline button--secondary button--lg"
26+
to="/docs/contribute"
27+
style={{ marginLeft: "1rem" }}
28+
>
29+
Contribute
2330
</Link>
2431
</div>
2532
</div>

0 commit comments

Comments
 (0)