-
Notifications
You must be signed in to change notification settings - Fork 76
Closed
Description
Summary
The current CONTRIBUTING.md provides a good foundation, but it can be enhanced for better clarity, structure, and onboarding for new developers.
Proposed Enhancements
-
Improve Code Block Formatting
- Ensure all code snippets are properly fenced and consistent (e.g., add missing triple backticks).
- Align numbered lists with their corresponding code snippets.
-
Refine Development Workflow Section
- Include step-by-step instructions from forking to submitting a PR.
- Add examples for branch naming conventions and commit messages.
- Clarify how to sync forks with the upstream repository.
-
Add “Tips for a Successful Pull Request” Section
- Include guidelines for writing PR descriptions, keeping changes focused, and adding tests.
-
Add Visuals / Screenshots (Optional)
- Include screenshots or diagrams to illustrate workflow steps for new contributors.
-
Link to Additional Resources
- Include links to relevant GitHub docs, style guides, or external resources for testing and commits.
-
Consistency Across Sections
- Ensure frontend, backend, testing, and documentation guidelines follow a uniform structure.
- Standardize headings, bullet points, and emojis for readability.
Expected Outcome
- A
CONTRIBUTING.md` that is beginner-friendly, clearly structured, and easy to follow. - Improved onboarding experience for new contributors.
- Reduced errors and questions about the contribution process.
Please assign this issue to me. I would like to work on this issue.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels