🗣 Hacktoberfest encourages participation in the open source community, which grows bigger every year. Complete the 2021 challenge and earn a limited edition T-shirt.
📢 Register here for Hacktoberfest and make four pull requests (PRs) between October 1st-31st to grab free SWAGS 🔥.
Steps for creating your first pull request (PR)
< Easy approach through browser />
1. Fork this repository
2. Goto branch named "hacktoberfest"
3. Navigate to "Contributors.js" in /client/src/pages/Contributors.js
4. Click "Edit" and add your entry
5. Add your name
6. Add a description (optional)
7. Copy your github profile's image address and add in imgUrl
8. Scroll down & commit your changes with a message
9. Goto "<>Code" tab & click Contribute
10. Open PR & create PR with a message
< Better approach through Git />
Prerequisites: None 😃 everything will be mentioned step-wise below.
-
Sign into GitHub | Create a free GitHub account
-
Install Git
a. Debian >sudo dnf install git-all
b. Ubuntu >sudo apt install git-all
c. Mac >git --version
d. Windows > Download -
Fork and Star the project repository
Find the project's repository on GitHub, and then "fork" it by clicking the Fork button in the upper right corner:
This creates a copy of the project repository in your GitHub account. In the upper left corner, you will see that you are now looking at a repository in your account:
-
Clone your fork
While still in your repository, click the green Clone or download button and then copy the HTTPS URL:
Using Git on your local machine, clone your fork using the URL you just copied:git clone URL_OF_FORK
For example, I used git clone https://github.com/Illusion0-0/gdsc-ait-website.git
Cloning copies the repository files (and commit history) from GitHub to your local machine. The repository will be downloaded into a subdirectory of your working directory, and the subdirectory will have the same name as the repository.
- Navigate to your local repository
Since the clone was downloaded into a subdirectory of your working directory, you can navigate to it using: cd NAME_OF_REPOSITORY.
For example, I used cd gdsc-ait-website
- Add the project repository as the "upstream" remote
Go to your fork on GitHub, and click the "forked from" link to return to the project repository:
While in the project repository, click the green Code button and then copy the HTTPS URL:
Add the project repository as the "upstream" remote using: git remote add upstream URL_OF_PROJECT.
For example, I used git remote add upstream https://github.com/DSC-AIT-Pune/gdsc-ait-website.git
Use git remote -v to check that you now have two remotes: an origin that points to your fork, and an upstream that points to the project repository.
-
Switch Branch to Hacktoberfest
Usegit checkout hacktoberfest& thengit branchto check current branch
Navigate to Contributors.js ascd client/src/pages
-
Make changes in your local repository
Add your entry as done by other contributors & save your changes -
Commit your changes
After you make a set of changes, usegit add -Ato stage your changes andgit commit -m "DESCRIPTION OF CHANGES"to commit them.
For example, I used git commit -m "Added Tarun" for one of my commits.
If you are making multiple sets of changes, it's a good practice to make a commit after each set.
-
Push your changes to your fork
git push
-
Begin the pull request
Return to your fork on GitHub, and refresh the page. You may see a highlighted area that displays your recently pushed branch:
Click the green Compare & pull request button to begin the pull request. -
Create the pull request
When opening a "pull request", you are making a "request" that the project repository "pull" changes from your fork. You will see that the project repository is listed as the "base repository", and your fork is listed as the "head repository":
Make sure the base & compare are set to "Hacktoberfest".
Before submitting the pull request, you first need to describe the changes you made (rather than asking the project maintainers to figure them out on their own). You should write a descriptive title for your pull request, and then include more details in the body of the pull request. If there are any related GitHub issues, make sure to mention those by number. The body can include Markdown formatting, and you can click the Preview tab to see how it will look.
On the right side, you may see a link to the project's Contributing guidelines. This is primarily worth reading through if you are submitting substantial code (rather than just fixing a typo), but it may still be worth scanning through at this point.
Below the pull request form, you will see a list of the commits you made in your branch, as well as the "diffs" for all of the files you changed.
If everything looks good, click the green Create pull request button!
If the project maintainers accept your pull request (congratulations!), they will merge your proposed changes into the project's master branch and close your pull request:
- Pull requests can be submitted to any opted-in repository on GitHub or GitLab.
- The pull request must contain commits you made yourself.
- If a maintainer reports your pull request as spam, it will not be counted toward your participation in Hacktoberfest.
- If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate.
- To get a shirt, you must make four approved pull requests (PRs) on opted-in projects between October 1-31 in any time zone.
- This year, the first 50,000 participants can earn a T-shirt.
👤 GDSC AIT
- Twitter: @dsc_ait
- Github: @DSC-AIT-Pune
- Facebook: @dsc.aitpune
- LinkedIn: @dsc-ait
- Discord: @Google Developer Student Club, AIT Pune
- Made with ❤️ by Google Developers Students Club, AIT
if (isAwesome) {
// thanks in advance :p
starThisRepository();
//⭐️
}
