docs: Organize and expand contributing documentation #253
Conversation
This file contains 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
The sibling headings use title case.
Reduce the size of the `README` file and begin reorganizing code contribution guidelines to simplify navigating additional content.
dcalhoun
added
the
[Type] Documentation
katinthehatsite
approved these changes
Jun 17, 2024
Contributors may not be familiar with the Calypso project or its purpose. Co-authored-by: Carlos Garcia <[email protected]>
Calypso is not associated with the open-source WordPress project.
Avoid potential confusion from missing or outdated dependencies by recommending that contributors always install the latest dependencies before building the source code.
|
Merged these changes with the feedback and approval provided thus far. 🚀 For context and posterity, I completed this reorganization as I felt the That said, anyone should feel welcome to further critque and/or reorganize the documentation. Documentation organization and tone is always quite subjective. I welcome others to continue proposing changes, as any documentation needs to evolve alongside its project as the scope and complexity increases. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Relates to p1718394299821639/1718026506.388569-slack-C06DRMD6VPZ.
Proposed Changes
Organize and expand documentation to capture helpful guidance and information
for contributors.
Testing Instructions
Navigate various links found within the
READMEfile and other documentationfiles.
Pre-merge Checklist