Skip to content

Commit 1a6c2ac

Browse files
committed
add contribution guide to readme
1 parent b0ee83c commit 1a6c2ac

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,32 @@ To run the documentation site locally:
3939

4040
The development server will automatically reload when you make changes to the documentation files.
4141

42+
## Contribution Guide
43+
44+
Thanks for contributing to Fern's documentation!
45+
46+
### Writing tips
47+
48+
Keep the following principles in mind:
49+
50+
- **Write for your audience** - Consider why users are reading your documentation and explain the use case clearly. Focus on clarity and completeness without being verbose. Add examples and code snippets when relevant.
51+
- **Help users get something done**. Don't try to sell users on the product, and avoid marketing language like "amazing features" or "the best solution."
52+
- **Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Use a friendly, casual tone and stay away from jargon as much as you can.
53+
- **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
54+
- **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
55+
56+
**For language and grammar help**, check out [Google's developer documentation style guide](https://developers.google.com/style) or Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
57+
58+
### Getting changes reviewed
59+
60+
If you want to **add a new page or make a large structural change**:
61+
- [File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign @devalog and @kgowru. We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work.
62+
63+
For **all other changes**:
64+
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
65+
66+
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to @devalog and @kgowru.
67+
68+
69+
70+

0 commit comments

Comments
 (0)