-
-
Notifications
You must be signed in to change notification settings - Fork 96.8k
Description
The "How to Contribute" section in the README provides written instructions for creating a pull request. Adding a visual guide with screenshots could help new contributors, especially those unfamiliar with GitHub, follow along more easily.
Suggested Improvements:
1)Include Screenshots for Key Steps:
Adding screenshots for steps like forking the repository, creating a new branch, making a commit, and opening a pull request.
For example:
-Show the Fork button on the repository page.
-Demonstrate where to navigate for Create New Branch.
-Highlight the New Pull Request button and what fields to fill in.
2)Create a New Section or Page for Visual Guide:
Consider adding these images directly to the README or linking to a new Markdown file (e.g., VISUAL_GUIDE.md) dedicated to step-by-step visuals.
This guide could be linked from the main README to make it easy for new users to find.
3)Briefly Explain Each Step Alongside the Image:
Under each screenshot, add a brief explanation of the action being taken, so users can follow along with minimal confusion.
Why This Matters:
Having a visual guide will help users who may struggle with written instructions alone. Screenshots can make the process more approachable and provide extra context, which could reduce the learning curve for first-time contributors. A visual aid could also decrease the number of common questions raised by new contributors in the Issues section.