Make your first Pull Request to brush up your Git skills for Hacktoberfest by contributing to this repository! PS: It won't count to Hacktoberfest PR.
This project is perfect starting point for your first Pull Request ( PR )
-
Clone your forked repository into your local machine
git clone https://github.com/<your-username>/hacktoberfest-2020.git
-
Create a new branch for your modifications (ie.
git checkout -b <your-branch-name>
) -
Add your profile image
github-username.jpg
insidesrc/images
-
Add your profile info by making make new file named
github-username.md
insidesrc/contributors
Insidegithub-username.md
copy the below template and edit your details. ( facebook, instagram, and twitter are optional. )--- name: "<your name>" username: "<github username>" image: "<your-image-name>" facebook: "<your facebook username>" instagram: "<your instagram username>" twitter: "<your twitter username>" --- Add About Yourself
- after you have done the changes
git add .
to add your changesgit commit -m <your commit message>
git push origin <your-branch-name>
- Create a pull request
- Star this repository
Replace <your-username>
with your GitHub username in this guide.
Add a picture picture of your choice in src/images
. Accepted files are jpg and png, should be squared in shape. Ex.
src/images/<your-username>.jpg
Be aware, this picture will be displayed on the actual site.
Create a markdown file in your folder following the convention src/contributors/<your-username>.md
. Ex.
src/contributors/<your-username>.md/
Copy the next template into your file, delete the boilerplate data and fill the information with yours (facebook, twitter and instagram are optional).
---
name: "<your name>"
username: "<github username>"
image: "<your-image-name>"
facebook: "<your facebook username>"
instagram: "<your instagram username>"
twitter: "<your twitter username>"
---
Add About Yourself 🖋📜
Note: Your image name in the template should be same img name you uploaded with extension.
Do not use special characters in the template above.
git add .
to add your changesgit commit -m <your commit message>
git push origin <your-branch-name>