specter-desktop
specter-desktop copied to clipboard
Docs: Improve clarity and structure of contribution guide
Hello Specter team!
As a new contributor looking to get involved, I was reading the CONTRIBUTING.md file. I noticed all the important information was there, but it could be restructured to make it a bit easier for a newcomer to read and find what they need.
This PR reformats the entire file into a clear, well-structured guide.
Summary of Changes:
- Added a Table of Contents for easy navigation.
- Created a clear, step-by-step
How to Contributesection. - Added a
Development Setupsection with quick-start commands and a link to the more detailed docs. - Organized existing information into clear, top-level sections:
Code StandardsTesting(with subsections for Backend and Frontend)Finding HelpContributors and Maintainers
- Added a friendly "Thank you" message at the end.
This PR does not change any code. It is purely a documentation improvement intended to help new contributors (like me!) get started more smoothly.
Looking forward to your feedback!
Deploy Preview for specter-desktop-docs canceled.
| Name | Link |
|---|---|
| Latest commit | f8f331125a353b8886ccb4982b24ac8b362c1a0f |
| Latest deploy log | https://app.netlify.com/projects/specter-desktop-docs/deploys/691a41991a32570008f0f944 |