Skip to content

Latest commit

 

History

History
148 lines (95 loc) · 6.12 KB

README.md

File metadata and controls

148 lines (95 loc) · 6.12 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://fineanmol.github.io/hacktoberfest/

image

A different kind of contribution this year

There’s a new way to contribute this year—financially. Hacktoberfest is the perfect time to give back to open source maintainers. Maintainers are the backbones of the software we all use. We all know backbones get sore after a long day, so consider sending them some support (and a lumbar pillow). The Hacktoberfest donation page is integrated with both GitHub Sponsors and OpenCollective to make it easy to find projects you’d like to thank. While you’re there, consider what smaller projects you benefit from and could especially use relative to resources.

New to contributing in open source?

Hacktoberfest can be an especially welcoming time to dip your toes into open source contributions for the first time. There’s plenty of streams, posts, guides, and conversations around getting started. You’re joining many folks also starting their journey this month!

Hacktoberfest’s website has some great resource for beginners: https://hacktoberfest.digitalocean.com/resources/beginners Guide to Making your First Contribution by Ceora Ford: https://dev.to/codesandboxio/how-to-make-your-first-open-source-contribution-2oim Practice the workflow for making your first contribution: https://github.com/firstcontributions/first-contributions Find good first issues: https://goodfirstissue.dev/ Overcoming impostor syndrome of contributing to open source: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source Open Source projects participating in Hacktoberfest: https://github.com/topics/hacktoberfest

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/fineanmol/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: Anmol Agarwal
// GITHUB: https://github.com/fineanmol

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

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

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

Here is my hello_world example: hello_world_anmolagarwal.js

BONUS!

  • Merging All Pull Requests
  • 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 some 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/fineanmol/f9b8943230e7031ae78cdcd1755bef32

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