CONTRIBUTING.md

Hacktoberfest-2021

This repository aims to help code beginners with their first successful pull request and open source contribution. 🥳

⭐ Feel free to use this project to make your first contribution to an open-source project on GitHub. Practice making your first pull request to a public repository before doing the real thing!

⭐ Make sure to grab some cool swags during Hacktoberfest by getting involved in the open-source community.

This repository is open to all members of the GitHub community. Any member can contribute to this project! 😁

👉 Repo Link : https://github.com/Opensourcecontri/Hacktoberfest-2021

What is Hacktoberfest? 🤔

A month-long celebration from October 1st to October 31st presented by Digital Ocean and DEV Community collaborated with GitHub to get people involved in Open Source. Create your very first pull request to any public repository on GitHub and contribute to the open-source developer community.

https://hacktoberfest.digitalocean.com/

Rules 🔥

To qualify for the official limited edition Hacktoberfest shirt, you must register here and make four Pull Requests (PRs) between October 1-31, 2021 (in any time zone). PRs can be made to any public repo on GitHub, not only the ones with issues labeled Hacktoberfest. This year, the first 70,000 participants who complete the challenge will earn a T-shirt.

Steps to follow 📜

0. Star The Repo 🌟

Star the repo by pressing the topmost-right button to start your wonderful journey.

1. Fork it 🍴

You can get your own fork/copy of HacktoberFest_2021 by using the Fork button or clicking this at top-right of your screen.

2. Clone it 👥

NOTE: commands are to be executed on Linux, Mac, and Windows(using Powershell)

You need to clone (download) it to local machine using

$ git clone https://github.com/Your_Username/Hacktoberfest-2021.git

This makes a local copy of the repository in your machine.

Once you have cloned the Hacktoberfest-2021 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-2021
$ cd Hacktoberfest-2021

Move to this folder for all other commands.

3. Set it up ⬆️

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-2021.git (fetch)
origin  https://github.com/Your_Username/Hacktoberfest-2021.git (push)

Now, let's add a reference to the original Hacktoberfest-2021 repository using

$ git remote add upstream https://github.com/Opensourcecontri/Hacktoberfest-2021.git

This adds a new remote named upstream.

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/Hacktoberfest-2021.git (fetch)
origin    https://github.com/Your_Username/Hacktoberfest-2021.git (push)
upstream  https://github.com/Remote_Username/Hacktoberfest-2021.git (fetch)
upstream  https://github.com/Remote_Username/Hacktoberfest-2021.git (push)

In your case, you will see

$ git remote -V
origin    https://github.com/Your_Username/Hacktoberfest-2021.git (fetch)
origin    https://github.com/Your_Username/Hacktoberfest-2021.git (push)
upstream  https://github.com/Opensourcecontri/Hacktoberfest-2021.git (fetch)
upstream  https://github.com/Opensourcecontri/Hacktoberfest-2021.git (push)

4. Sync it ♻️

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

5. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Good First Issue Issues and creating pull requests.

6. Create a new branch ‼️

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.

Awesome contributors 🤩

Made with contributors-img.

Help Contributing Guides 👑

We love to have articles and codes in different languages and the betterment of existing ones.

Please discuss it with us first by creating a new issue.

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉