The current README.md file in the repository has several formatting issues that may hinder the readability and understanding for potential contributors. Proper formatting is essential for clarity and ease of use, especially for new contributors.
Issues Identified:
Inconsistent Indentation:
Some sections have inconsistent indentation, which affects the overall layout. For example, the steps under "How to Contribute" should maintain consistent indentation levels.
Bullet Points Formatting:
The bullet points under "What We Expect" and "Contribution Guidelines" are not uniformly formatted. It would be beneficial to ensure all bullet points are styled similarly for better readability.
Code Blocks Formatting:
The code blocks (e.g., Git commands) should be enclosed in triple backticks (```) for clearer distinction from the text.
Section Headers:
Section headers (like "How to Contribute", "What We Expect", etc.) could benefit from a more consistent use of Markdown styling (e.g., using the same number of # for headers).
Spacing:
Adding more spacing between sections can improve readability and make it easier for contributors to skim the document.
Beauty-ku-mari
commented
1 week ago
The current README.md file in the repository has several formatting issues that may hinder the readability and understanding for potential contributors. Proper formatting is essential for clarity and ease of use, especially for new contributors.
Issues Identified:
Some sections have inconsistent indentation, which affects the overall layout. For example, the steps under "How to Contribute" should maintain consistent indentation levels.
The bullet points under "What We Expect" and "Contribution Guidelines" are not uniformly formatted. It would be beneficial to ensure all bullet points are styled similarly for better readability.
The code blocks (e.g., Git commands) should be enclosed in triple backticks (```) for clearer distinction from the text.
Section headers (like "How to Contribute", "What We Expect", etc.) could benefit from a more consistent use of Markdown styling (e.g., using the same number of # for headers).
Adding more spacing between sections can improve readability and make it easier for contributors to skim the document.
Please Assign it to me.