-
Notifications
You must be signed in to change notification settings - Fork 7
Description
Title: 🚀 Enhance our CONTRIBUTING.md Guide for New Contributors
Description
Our current CONTRIBUTING.md file provides a good starting point for new contributors, but we want to make it even better! The goal is to make it more visual, engaging, and crystal clear, so that anyone, regardless of their experience level, can feel confident contributing to our project.
We believe that adding more visuals (like GIFs and annotated screenshots) and clarifying our processes will significantly lower the barrier to entry for first-time contributors.
Your Task
We're looking for someone to enhance our CONTRIBUTING.md file. Here are the specific improvements we'd like to see:
✅ Acceptance Criteria (What needs to be done)
[ ] Create and Add GIFs:
[ ] Create a GIF showing the process of forking the repository and add it to the "Your First Code Contribution" section.
[ ] Create a GIF showing how to create a new branch from the command line.
[ ] Create a GIF showing how to create a Pull Request on GitHub, from the contributor's forked repo to our main repo.
[ ] Add More Detailed Explanations:
[ ] Add a new section titled "What Happens After You Submit a PR?" Explain the review process: a maintainer will be assigned, they might ask for changes, CI/CD checks will run, and finally, it will be merged.
[ ] Add a small section explaining the common labels we use on issues (e.g., bug, feature, documentation, good first issue). This helps contributors find things to work on.
[ ] Add Annotated Screenshots:
[ ] Replace the placeholder image under "Reporting Bugs" with a real, annotated screenshot showing where the "Issues" tab and "New Issue" button are.
[ ] Replace the placeholder image under "Suggesting Enhancements" with an example of a good enhancement suggestion or a simple wireframe.
[ ] Review and Refine:
[ ] Read through the entire document to check for clarity, grammar, and a friendly, encouraging tone.
How to Submit Your Changes
Fork the repository.
Create a new branch for your changes.
Update the CONTRIBUTING.md file with the enhancements listed above.
Submit a Pull Request and link it back to this issue.
We are incredibly excited to see your improvements. This contribution will help grow our community and make our project more welcoming for everyone. Thank you for your help! ✨