first-contributions icon indicating copy to clipboard operation
first-contributions copied to clipboard

Add Step-by-Step Visual Guide for Creating a Pull Request

Open prashu0705 opened this issue 1 year ago • 6 comments

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.

prashu0705 avatar Oct 15 '24 16:10 prashu0705

would like to help by working on this

CODERPP10 avatar Oct 16 '24 08:10 CODERPP10

Yes I would like to work on this. Pls assign it to me.

prashu0705 avatar Oct 16 '24 08:10 prashu0705

Hello , I am new to opensource and I hveve recently learned this. Please assign me this task.

Rutujaj24 avatar Oct 16 '24 16:10 Rutujaj24

Hey, it’s my first contribution as well and I really need this.

prashu0705 avatar Oct 16 '24 16:10 prashu0705

Hi, Can you assign this issue to me? I am new to open source and would like to work on this.

Ishpreet01 avatar Dec 23 '24 07:12 Ishpreet01

Shout out to sammyhori for adding first contributions to https://github.com/MunGell/awesome-for-beginners

Sardorbek-Kuvondikov avatar Jan 04 '25 09:01 Sardorbek-Kuvondikov

Hi @prashu0705, similarly recentlyi worked on the issue eg: add_pr_template i will give uh the same below?

pull_request_template.md

I’d like to work on this issue by creating a step-by-step visual guide with screenshots for the key steps you mentioned. My plan: Capture screenshots for forking the repo, creating a branch, committing changes, and opening a pull request. Add short explanations under each screenshot. Include the guide in a new VISUAL_GUIDE.md file and link it from the README. Does this approach align with what you have in mind?

DeveshPatill avatar Aug 09 '25 14:08 DeveshPatill