Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatting Issues in README.md #14

Open
MohammedMusharraf11 opened this issue Oct 9, 2024 · 1 comment
Open

Formatting Issues in README.md #14

MohammedMusharraf11 opened this issue Oct 9, 2024 · 1 comment
Assignees

Comments

@MohammedMusharraf11
Copy link

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.

Please Assign it to me.

@Beauty-ku-mari
Copy link
Owner

ok bro

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants