Fix doc typo #5998
Open
Fix doc typo #5998
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
zainabfatima097
commented
Jun 29, 2025
There was a problem hiding this comment.
🐛 Description
Fixes #5754 – Clarified the contribution guide with additional details for first-time contributors.
📚 Context
The original documentation lacked clarity on how to properly set up the local environment and run tests.
This PR adds missing steps and improves the flow, based on my first-time experience contributing.
✅ Checklist
- Documentation updated
- Linked to an open issue
- Improvements focused on beginner friendliness and completeness
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.
📝 Description
This PR fixes a minor documentation issue related to issue #552.
Corrected a typo/inaccuracy to improve clarity for new contributors and readers.
🔍 Context
While reading the docs, I noticed a confusing/inaccurate section that could potentially trip up beginners.
This change improves the developer experience by making the documentation more precise and easier to follow.
✅ Checklist