From 0baef36b43bdd22f255781d414aa7def32609226 Mon Sep 17 00:00:00 2001 From: Suraj Kumar Date: Sat, 30 Mar 2024 15:38:16 +0530 Subject: [PATCH] fix: Updated the readme file with easy understanding of steps of contribution. --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 77fb20d..4e239be 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## [Getting to Know Git and GitHub: _Your Code's Best Friends_](https://surajk00.hashnode.dev/getting-to-know-git-and-github-your-codes-best-friends#heading-what-is-git) -![Git and Github](https://cdn.hashnode.com/res/hashnode/image/upload/v1693398758809/3aab0636-bb93-4b41-9389-3c0edfc89754.png?w=1600&h=840&fit=crop&crop=entropy&auto=compress,format&format=webp) +![Git and Github](./Assets/git_github_banner.png) --- @@ -26,7 +26,7 @@ > Ⅲ. Clone the project to run on your local machine using the following command: ```sh - git clone URL of forked repo +git clone URL of forked repo ``` > Ⅳ. Get into the root directory if you are not @@ -43,29 +43,35 @@ git checkout -b example: git chekcout -b suraj/contributor ``` -> Ⅵ. Make a directory. +> Ⅵ. Move to Contributors directory. ```sh -mkdir Contributors/github_username +cd Contributors ``` -> Ⅶ. Create a markdown file. +> Ⅶ. Create a directory. ```sh -touch Contributors/github_username/your_name.md +mkdir your_github_username ``` -> Ⅷ. Add your details in the markdown file and save it. +> Ⅷ. Create a markdown file. + +```sh +touch your_github_username/your_name.md +``` + +> Ⅸ. Add your details in the markdown file and save it. ```sh --- -Name: Alex -GitHub_username: Alex-00 +Name: John Doe +GitHub_username: JohnD-00 Linkedin/Twitter: Link_of_Social_post_where_you_share_your_learning --- ``` -> Ⅸ. Stage your changes +> Ⅹ. Stage your changes ```sh git add filename @@ -73,19 +79,19 @@ or git add . // the '.' means here to add all the files ``` -> Ⅹ. Commit your changes +> Ⅺ. Commit your changes ```sh git commit -m "your-commit-message" ``` -> Ⅺ.Push your changes to your branch +> Ⅻ.Push your changes to your branch ``` -git push origin "" +git push origin "your_branch_name" ``` -> Ⅻ. Create a [pull request](https://github.com/Suraj-kumar00/Getting-started-with-Git-Github/compare) so, that we can merge it. +> Ⅼ. Create a [pull request](https://github.com/Suraj-kumar00/Getting-started-with-Git-Github/compare) so, that we can merge it. > XIII. Share your learning with this repo on social.