A better read me and made it easier to contribute to the read me #4883
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 project has great potential but the read me is not that good
the improvement includes the proper structure and separation into clear sections, quick links for easier navigation, different guides for project maintainers and contributors, setup and contribution instructions in detail, architecture description, community guidelines and support sections, improved formatting and readability, various emojis to help make it more visually interesting and scannable, and clear step-by-step instructions on how to perform common tasks.
Best regards,
- Zawad (Hoping for the best)
|
👋 I'm a robot checking the state of this pull request to save the human reviewers time. I don't see any changes under As you make changes to this pull request, I'll re-run these checks. |
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.
The project has great potential but the read me is not that good
the improvement includes the proper structure and separation into clear sections, quick links for easier navigation, different guides for project maintainers and contributors, setup and contribution instructions in detail, architecture description, community guidelines and support sections, improved formatting and readability, various emojis to help make it more visually interesting and scannable, and clear step-by-step instructions on how to perform common tasks.
Best regards,
- Zawad (Hoping for the best)