Skip to content

Latest commit

 

History

History
168 lines (104 loc) · 6.93 KB

README.md

File metadata and controls

168 lines (104 loc) · 6.93 KB
Raw

Open-source-Practice

Winter of Blockchain, founded by GirlScript Foundation India in 2022, is a 2-month open source program designed to empower blockchain enthusiasts.

Open-Source-Practice Pull Requests

Repository for you to raise a Pull Request to practice open-source! 🎉

Add your name to the alphabetical list under WoB Community and, optionally, a link to your GitHub account (in alphabetical order below your letter too)

Option 1. Complete this process in GitHub (in your browser)

flowchart LR
    Fork[Fork the project]-->branch[Create a New Branch]
    branch-->Edit[Edit file]
    Edit-->commit[Commit the changes]
    commit -->|Finally|creatpr((Create a Pull Request))
Loading

1. Fork the project:

  • Click the gray Fork button at the top right of the previous page. This creates your copy of the project and saves it as a new repository in your GitHub account.

2. Create a New Branch:

  • On your new repository's page, click the gray main button in the upper left to reveal a dropdown menu.
  • Enter the name of your new branch in the text box. (Branch names usually refer to what is being changed. Example: nameAdd). -Click on Create branch , which will automatically take you to your new branch. You can make edits on the main branch, but this may cause issues down the line. The best practice is to create a new branch for each separate issue you work on. That way your main branch remains in sync with WoB's main branch.

3. Edit:

  • On the top right of the Readme file, click on the pencil icon to edit the file by adding your name and your GitHub profile link to the section that matches your Initial in this list. Make sure that your name is in alphabetical order.
  • After editing the Readme file, add a commit message (Added my name or it can be anything related to your commit) and click on the green button saying "Commit Changes". Make sure you have selected the branch you have created.

4. Raise a Pull Request:

  • Click Pull Requests option in your forked repository (which is the third option at the top of this page after the options Code and Issues).
  • Click the green New Pull Request button. This will prep the new pull request for you by auto-filling the base repository: base with 'Open-source-Practice: main' AND auto-filling your head repository: compare with your repository: main
  • Click on your head repository's compare dropdown, and switch branches from your 'main' branch to <new branch name>.
  • Finally, click the green Create Pull Request button. Great job! You did it!

You can ask questions by raising an issue.

Option 2. Complete this process on your computer (locally)

1. Fork the project:

  • Click the gray Fork button at the top right of the previous page. This creates your copy of the project and saves it as a new repository in your GitHub account.

2. Clone this project on your computer:

  • Go to your profile. You will find forked repo named open-source-practice. go to the repo by clicking on it.

  • Click on the green Code button, then either the HTTPS or SSH option, and, click the icon to copy the URL. Now you have a copy of the project. Thus, you can play around with it locally on your computer.

  • Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Bash, ZSH). Do this to download the forked copy of this repository to your computer.

  git clone https://github.com/Girlscript-WOB/Open-source-Practice.git
  • Switch to the cloned folder. You can paste this command into the same terminal window.
  cd Open-source-Practice

3. Open in code Editor:

  • Open the README.md file

4. Create a new branch:

  • Your username would make a good branch name because it's unique.
  git checkout -b <name-of-new-branch>

5. Edit the File:

  • Add your name to the section that matches your Initial in this list, make sure that your name is in alphabetical order.Then save your changes.

  • For example - [Full Name](https://github.com/your-username)

5. Stage your changes:

  git add README.md

or you can stage all the changes using-

  git add .

6. Commit the changes:

  git commit -m "Add <your-github-username>"
  • Check the status of your repository.
  git status
  • The response should be like this:
On branch <name-of-your-branch>
nothing to commit, working tree clean

7. Pushing your repository to GitHub:

  git push origin <name-of-your-branch>

or

  git branch -M main
  git push -u origin main

Warning: If you get an error message like the one below, you probably forgot to fork the repository before cloning it. It is best to start over and fork the project repository first.

ERROR: Permission to https://github.com/Girlscript-WOB/Open-source-Practice denied to <your-github-username>.
fatal: Could not read from remote repository.
Please make sure you have the correct access rights and that the repository exists.

8. Raise a Pull Request:

  • On the GitHub website, navigate to your forked repo - on the top of the files section, you'll notice a new section containing a Compare & Pull Request button! ![createpr]

  • Click on that button, this will load a new page, comparing the local branch in your forked repository against the main branch in the GirlScript-WOB Open-Source-Practice repository. Do not make any changes in the selected values of the branches (do so only if needed), and click the green Create Pull Request button. Note: A pull request allows us to merge your changes with the original project repo.

  • Your pull request will be reviewed and then eventually merged.

Hurray! You successfully made your first contribution! 🎉

How can I fix a merge conflict?

A GitHub conflict is when people make changes to the same area or line in a file. This must be fixed before it is merged to prevent collision in the main branch.

Video demonstration for Mentors and CAs to open pull requests

Girlscript-WOB.mp4

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.