Improve README structure and clarity for new contributors #3629
+85
−86
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
- Add quick start guide with clear prerequisites and setup steps - Reorganize content with better structure and visual hierarchy - Emphasize testing requirements before PR submission - Move advanced Heroku deployment section to end - Clarify language guidelines for global developer audience - Remove duplicate sections and improve flow
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.
Summary
While making my own contributions to this project, I found myself jumping around the README to confirm setup details and contribution steps. This PR reorganizes the content to create a clearer flow for anyone wanting to pull down the repo and run it locally.
Key Changes
Goals
Make it easier for developers to:
Thanks for maintaining such a welcoming project! Hope this helps more people contribute to Ruby's website. 🎉
Note: No functional changes - purely documentation improvements.