Docs: Improve clarity and structure of contribution guide #2508
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for specter-desktop-docs canceled.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello Specter team!
As a new contributor looking to get involved, I was reading the
CONTRIBUTING.mdfile. 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:
How to Contributesection.Development Setupsection with quick-start commands and a link to the more detailed docs.Code StandardsTesting(with subsections for Backend and Frontend)Finding HelpContributors and MaintainersThis 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!