Skip to content
This repository has been archived by the owner on May 23, 2020. It is now read-only.

Latest commit

 

History

History
41 lines (29 loc) · 2.37 KB

index.md

File metadata and controls

41 lines (29 loc) · 2.37 KB
layout permalink
index
/

Welcome to HacktoberFest

HacktoberFest Banner

Welcome to Sunway Tech Club's HacktoberFest repo!

This is where you can find the profile of others, which had their pull requests approved in Profiles.

Want your profile in here too? Come on over to our repo{:target="_blank"} and ask one of us on how to make your very first pull request if you don't know how!

Before you get started

  1. First thing you would need to do (if you haven't already), is to sign up{:target="_blank"} for a GitHub account
  2. Next, you should log in or join{:target="_blank"} the official HacktoberFest website
  3. Our workshop will be using GitHub Desktop, so please do download it{:target="_blank"}
  4. Finally, to make your changes for your first Pull Request, you would need a text editor
  • Any text editor is fine (except for the original Microsoft Notepad), but one we would recommend is Sublime Text{:target="_blank"}

Getting your Pull Request (PR) accepted

Other than the commands/buttons needed to get your PR sent to us, many repos out there in the wild will require you to follow certain guidelines to ensure a certain form of standard to their repo.

It is no different here, although our rules are certainly more relaxed than the others ;)

You need to make sure that your PR fulfils the following requirements when you are submitting your profile:

  1. Your profile must be in md extension, and must be in _posts folder
  2. The name of your file must be in YYYY-M-D-title-name format, where you replace spaces with dashes. Example: 2019-9-18-Making-Your-First-PR
  3. The top of your file's content must have the following, where:
  • layout must be post
  • title can be anything you want to be. Example: Making Your First PR
  • The --- must be wrapped above and below the layout and title
  • Front Matter Example
  1. If images are used in your profile, it can be a direct link to it, if you want to add the image to our repo, please add it to images folder
  • Images Folder
  • Images can then be linked with /images/name-of-your-image