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.
Hacktoberfest is open to everyone in our global community. Whether you’re a seasoned contributor or looking for projects to contribute to for the first time, you’re welcome to participate.
Pull requests can be made in any GitHub-hosted repositories/projects. As long as the project is public and GitHub-hosted, your pull requests will count toward your participation.
You can sign up anytime between October 1 and October 31. Just be sure to sign up on the official Hacktoberfest website for your pull requests to count.
To get a shirt, you must make four pull requests (PRs) between October 1–31 in any time zone. Pull requests can be to any public repository on GitHub, not just the ones highlighted. The pull request must contain commits you made yourself. If a maintainer reports your pull request as spam, it will not be counted toward your participation in Hacktoberfest. If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate. This year, the first 75,000 participants can earn a T-shirt.
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!
- 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!
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)
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)
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: YOUR NAME
// GITHUB: /~https://github.com/YOUR_REPOSITORY
console.log('Hello, World!');
Name the file hello_world_yourusername.xx
. e.g., hello_world_loracsilva.js
or hello_world_loracsilva.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_loracsilva.js]
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
Github-Flavored Markdown https://guides.github.com/features/mastering-markdown/
GitHub license explained https://choosealicense.com