docs: improve CONTRIBUTING.md for better onboarding and documentation… #6
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
… clarity ## Summary This pull request improves the `CONTRIBUTING.md` guide to make it more accessible for new contributors and clearer for those wishing to help with documentation. ### Changes made: 1. **Updated welcome message** to be more inclusive and beginner-friendly. 2. **Added a new section** for contributing to documentation, including suggested steps and examples. 3. **Enhanced the forking instructions** with a direct link to the GitHub Fork button for easier navigation. 4. **Added a note under 'Step 6: Push'** to clarify how to mark documentation-only pull requests for quicker review. These changes aim to make the onboarding process smoother, especially for those contributing to documentation. ## Motivation As a new contributor, I found some steps unclear or lacking context, especially for those focused on documentation contributions. I hope this update can help others get started more easily. ## Checklist - [x] Edits limited to documentation only - [x] Follows contribution guidelines - [x] Markdown preview checked for formatting Thanks for considering this contribution!
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.
… clarity
Summary
This pull request improves the
CONTRIBUTING.mdguide to make it more accessible for new contributors and clearer for those wishing to help with documentation.Changes made:
These changes aim to make the onboarding process smoother, especially for those contributing to documentation.
Motivation
As a new contributor, I found some steps unclear or lacking context, especially for those focused on documentation contributions. I hope this update can help others get started more easily.
Checklist
Thanks for considering this contribution!