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))
Star the repository by pressing the topmost-right button to start your wonderful journey.
You can get your own fork/copy of HacktoberFest-2022 by using the Fork button.
NOTE: commands are to be executed on Linux, Mac, and Windows(using Powershell)
You need to clone or (download) it to local machine using
$ git clone https://github.com/Your_Username/Hacktoberfest-2022.git
This makes a local copy of the repository in your machine.
Once you have cloned the Hacktoberfest-2022
repository in Github, move to that folder first using change directory command on Linux, Mac, and Windows(PowerShell to be used).
# This will change directory to a folder Hacktoberfest-2022
$ cd Hacktoberfest-2022
Move to this folder for all other commands.
Run the following commands to see that your local copy has a reference to your forked remote repository in Github
$ git remote -v
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
Now, let's add a reference to the original Hacktoberfest-2022 repository using
$ git remote add upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git
This adds a new remote named upstream.
See the changes using
$ git remote -v
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
upstream https://github.com/Remote_Username/Hacktoberfest-2022.git (fetch)
upstream https://github.com/Remote_Username/Hacktoberfest-2022.git (push)
In your case, you will see
$ git remote -V
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git (fetch)
upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git (push)
Always keep your local copy of the repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.
# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune
# Switch to `main` branch
$ git checkout main
# Reset local `main` branch to match the `upstream` repository's `main` branch
$ git reset --hard upstream/main
# Push changes to your forked `Hacktoberfest-2021` repo
$ git push origin main
Once you have completed these steps, you are ready to start contributing by checking our Good First Issue
Issues and creating pull requests.
Whenever you are going to contribute. Please create a separate branch using command and keep your main
branch clean (i.e. synced with remote branch).
# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b BranchName
Create a separate branch for contribution and try to use the same name of the branch as of folder.
To switch to the desired branch
# To switch from one folder to other
$ git checkout BranchName
To add the changes to the branch. Use
# To add all files to branch Folder_Name
$ git add .
Type in a message relevant for the code reviewer using
# This message get associated with all files you have changed
$ git commit -m 'relevant message'
Now, Push your awesome work to your remote repository using
# To push your work to your remote repository
$ git push -u origin BranchName
Finally, go to your repository in the browser and click on compare and pull requests
.
Then add a title and description to your pull request that explains your precious effort.