CircuitVerseDocs
CircuitVerseDocs copied to clipboard
Fix the git command in README.md
I am submitting a -
- [] Bug Report
Describe your bug/feature - Typo in the command mentioned in "Steps to Contributing" section of README.md
Current behaviour - git commit -am 'Add feature'
Expected behaviour - git commit -m 'Add feature'
Screenshots (if relevant) - Null
Are you working on this issue? (Yes/No) - Yes, I am working on this issue.
Clone it :busts_in_silhouette:
You need to clone (download) it to local machine using
$ git clone https://github.com/Your_Username/cbcpp.git
This makes a local copy of repository in your machine.
Once you have cloned the cbcpp
repository in Github, move to that folder first using change
directory command on linux and Mac.
# This will change directory to a folder cbcpp
$ cd cbcpp
Move to this folder for all other commands.
Create a branch
# Change to the repository directory on your computer (if you are not already there):
$ cd first-contributions
Now create a branch using the git checkout command:
$ git checkout -b <add-your-name>
# For example:
$ git checkout -b add-alonzo-church
Make necessary changes and commit those changes
Now open Contributors.md
file in a text editor, add your name to it, and then save the file. If you go to the project directory and execute the command git status
, you'll see there are changes. Add those changes to the branch you just created using the git add
command:
$ git add Contributors.md
Now commit those changes using the git commit
command:
$ git commit -m "Add <your-name> to Contributors list"
replacing <your-name>
with your name.
Push changes to GitHub
Push your changes using the command git push
:
$ git push origin <add-your-name>
replacing <add-your-name>
with the name of the branch you created earlier.
Submit your changes for review
If you go to your repository on GitHub, you’ll see a Compare & pull request
button.Now submit the pull request.
Keeping your fork synced with this repository
First, switch to the master branch.
$ git checkout master
Then add my repo’s url as upstream remote url
:
$ git remote add upstream https://github.com/Roshanjossey/first-contributions
This is a way of telling git that another version of this project exists in the specified url and we’re calling it upstream
. Once the changes are merged, fetch the new version of my repository:
$ git fetch upstream
Here we’re fetching all the changes in my fork (upstream remote). Now, you need to merge the new revision of my repository into your master branch.
$ git rebase upstream/master
Here you’re applying all the changes you fetched to master branch. If you push the master branch now, your fork will also have the changes:
$ git push origin master
Notice here you’re pushing to the remote named origin.
At this point I have merged your branch <add-your-name>
into my master branch, and you have merged my master branch into your own master branch. Your branch is now no longer needed, so you may delete it:
$ git branch -d <add-your-name>
and you can delete the version of it in the remote repository, too:
$ git push origin --delete <add-your-name>
This isn’t necessary, but the name of this branch shows its rather special purpose. Its life can be made correspondingly short.
Fix the git command in README.md https://github.com/CircuitVerse/CircuitVerseDocs/issues/144#issuecomment-554750766
Is this issue still open?
The issue #144 is sorted I guess. If you want to contribute you can try out other issue present for circuit verse @chehak123 .