Skip to content

Latest commit

 

History

History
132 lines (86 loc) · 4.9 KB

README.md

File metadata and controls

132 lines (86 loc) · 4.9 KB
Raw

🎃 HacktoberFest Starter Project 🎃

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!

Celebrate Hacktoberfest by getting involved in the open source community by completing some simple tasks in this project.

This repository is open to all members of the GitHub community. Any member may contribute to this project without being a collaborator.

https://alicewonderland.github.io/hacktoberfest/

What is Hacktoberfest?

A month-long celebration from October 1st - 31st sponsored by Digital Ocean and 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/

How to contribute to this project

Here are 3 quick and painless ways to contribute to this project:

  • Add your name to the CONTRIBUTORS.md file
  • Add a profile page to the profiles directory
  • Create a simple "Hello, World" script in a language of your choice

Choose one or all 3, make a pull request for your work and wait for it to be merged!

Getting started

  • Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)
  • Clone your fork down to your local machine
git clone https://github.com/your-username/hacktoberfest.git
  • Create a branch
git checkout -b branch-name
  • Make your changes (choose from any task below)
  • Commit and push
git add .
git commit -m 'Commit message'
git push origin branch-name
  • Create a new pull request from your forked repository (Click the New Pull Request button located at the top of your repo)
  • Wait for your PR review and merge approval!
  • Star this repository if you had fun!

Choose from these tasks

1. Add your name

Add your name to the CONTRIBUTORS.md file using the below convention:

#### Name: [YOUR NAME](GitHub link)
- Place: City, State, Country
- Bio: Who are you?
- GitHub: [GitHub account name](GitHub link)

2. Add a profile page

Add a Your_Name.md file to the profiles directory. Use any combination of content and Markdown you'd like. Here is an example:

# Your Name

### Location

Your City/Country

### Academics

Your School

### Interests

- Some Things You Like

### Development

- Inventor of the My Pillow

### Projects

- [My Project](GitHub Link) Short Description

### Profile Link

[Your Name](GitHub Link)

3. Create a Hello, World! Script

Add a hello_world_yourusername.xx script to the scripts directory in any language of your choice! Here is an example:

// LANGUAGE: Javascript
// ENV: Node.js
// AUTHOR: Alice Chuang
// GITHUB: https://github.com/AliceWonderland

console.log('Hello, World!');

Name the file hello_world_yourusername.xx. e.g., hello_world_alicewonderland.js or hello_world_alicewonderland.py.

Don't forget to include the comments as seen above. Feel free to include additional information about the lanuage you chose in your comments too! Like a link to a helpful introduction or tutorial.

hello_world_alicewonderland.js

BONUS!

  • See profiles submitted by fellow coders from around the globe. From Kathmandu to Copenhagen.
  • Discover some obscure to new and trending languages. From BrainFuck to Groovy.
  • Check out very creative ways to print out a "Hello, World!" string

Reference links

Here is a great tutorial for creating your first pull request by Roshan Jossey: https://github.com/Roshanjossey/first-contributions

Managing your Forked Repo: https://help.github.com/articles/fork-a-repo/

Syncing a Fork: https://help.github.com/articles/syncing-a-fork/

Keep Your Fork Synced: https://gist.github.com/CristinaSolana/1885435

Checkout this list for README examples - Awesome README Awesome

Github-Flavored Markdown https://guides.github.com/features/mastering-markdown/

Additional references added by contributors

GitHub license explained https://choosealicense.com