Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.43 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.43 KB

Hacktoberfest2020

Make your first Pull Request and earn a free tee from GitHub!

Hacktoberfest 2020

GitHub issues GitHub forks GitHub stars Github license

# Welcome to GitHub!

This project is perfect for your first pull request

Instructions-

  • Fork this Repository using the button at the top
  • Clone your forked repository to your pc
  • Create a new branch for your modifications (ie. git branch new-user and check it out git checkout new-user and git checkout -b new-user)
  • Add your profile image in static/images/
  • Add your profile data in content/participant/
  • Add your files (git add -A), commit (git commit -m "added myself") and push (git push origin new-user)
  • Create a pull request
  • Star this repository

How to make your first Pull Request

Replace <YOUR-USERNAME> with your GitHub username in this guide.

1. Add your profile picture to the folder

Add a picture picture of your choice in static/images/. Accepted files are png and jpg, should be squared and minimum size 544x544 pixels. Ex.

static/images/<YOUR-USERNAME>.png

Be aware, this picture will be displayed on the yearbook!

2. Add your profile information

Create a markdown file in your folder following the convention content/participant/<YOUR-USERNAME>.md. Ex.

content/participant/<YOUR-USERNAME>.md/

Copy the next template into your file, delete the boilerplate data and fill the information with yours.

---
name: FULLNAME-OR-NICKNAME # No longer than 28 characters
institution: INSTITUTION-NAME 🚩 # no longer than 58 characters
image: <YOUR-USERNAME>.png # Name and extension of your profile picture(ex. <YOUR-USERNAME>.png) The picture must be squared and 544px on width and height.
quote: YOUR-SENIOR-QUOTE # no longer than 100 characters, avoid using quotes(") to guarantee the format remains the same.
github: YOUR-GITHUB-USERNAME
---

Do not use special characters in the template above.

4. Wait for Pull Request to merge

5. Celebrate - you've done your first pull request!!