Welcome to the Hacktoberfest Starter Project! We're excited to have you here. This document will guide you through the process of making your first contribution to open source.
- What is Hacktoberfest?
- Getting Started
- How to Contribute
- Contribution Tasks
- Pull Request Process
- Code of Conduct
- Additional Resources
Hacktoberfest is a month-long celebration from October 1st - 31st sponsored by Digital Ocean and GitHub to get people involved in Open Source. Learn more at hacktoberfest.com.
- A GitHub account
- Git installed on your local machine
- Basic knowledge of Git commands
-
Fork this repository
- Click the Fork button in the top right of this page
- Select your profile to create a fork
-
Clone your forked repository
git clone https://github.com/your-username/hacktoberfest.git
-
Navigate to the project directory
cd hacktoberfest -
Create a new branch
git checkout -b branch-name
Use a descriptive branch name like
add-yournameoradd-hello-world-python -
Make your changes (see Contribution Tasks below)
-
Stage your changes
git add . -
Commit your changes
git commit -m "Add: brief description of your changes"Write a clear, concise commit message
-
Push to your fork
git push origin branch-name
-
Create a Pull Request
- Go to your forked repository on GitHub
- Click the "New Pull Request" button
- Ensure the base repository is the original and compare branch is your branch
- Add a title and description explaining your changes
- Submit the pull request
-
Wait for review
- A maintainer will review your PR
- Make any requested changes if needed
- Once approved, your PR will be merged!
Choose one or all of the following tasks to contribute:
Add your information to the CONTRIBUTING.md file using the following format:
#### Name: [YOUR NAME](GitHub link)
- Place: City, State, Country
- Bio: Who are you?
- GitHub: [GitHub account name](GitHub link)Example:
#### Name: [Jane Doe](https://github.com/janedoe)
- Place: San Francisco, California, USA
- Bio: Full-stack developer passionate about open source
- GitHub: [janedoe](https://github.com/janedoe)Create a Your_Name.md file in the profiles directory. Use the following template:
# 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)Example:
# Jane Doe
### Location
San Francisco, USA
### Academics
University of California, Berkeley
### Interests
- Web Development
- Machine Learning
- Open Source
### Development
- Full Stack Developer at Tech Company
- Open Source Contributor
### Projects
- [Awesome Project](https://github.com/janedoe/awesome-project) A cool web app built with React
### Profile Link
[Jane Doe](https://github.com/janedoe)Add a hello_world_yourusername.xx script to the scripts directory in any language of your choice.
Requirements:
- Name your file:
hello_world_yourusername.extension- Example:
hello_world_janedoe.jsorhello_world_janedoe.py
- Example:
- Include comments with:
- Language name
- Environment/Runtime
- Your name
- Your GitHub profile link
- Place the file in the appropriate language folder
Template:
// LANGUAGE: JavaScript
// ENV: Node.js
// AUTHOR: Your Name
// GITHUB: https://github.com/yourusername
console.log('Hello, World!');More Examples:
Python:
# LANGUAGE: Python
# ENV: Python 3
# AUTHOR: Your Name
# GITHUB: https://github.com/yourusername
print('Hello, World!')Java:
// LANGUAGE: Java
// ENV: JDK 11+
// AUTHOR: Your Name
// GITHUB: https://github.com/yourusername
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}C++:
// LANGUAGE: C++
// ENV: GCC
// AUTHOR: Your Name
// GITHUB: https://github.com/yourusername
#include <iostream>
int main() {
std::cout << "Hello, World!" << std::endl;
return 0;
}- Ensure your code follows the guidelines outlined in this document
- Update documentation if you're adding new features
- Test your changes before submitting
- Write a clear PR description explaining what you've done and why
- Link any relevant issues in your PR description
- Be patient - maintainers will review your PR as soon as possible
- Respond to feedback - if changes are requested, make them promptly
Use clear, descriptive titles:
Add: [Your Name] to contributorsAdd: Hello World script in PythonAdd: Profile page for [Your Name]
We are committed to providing a welcoming and inspiring community for all. Please be respectful and considerate in your interactions.
- Be respectful - treat everyone with respect and kindness
- Be inclusive - welcome newcomers and help them learn
- Be collaborative - work together and share knowledge
- Be patient - remember everyone was a beginner once
- No harassment - we have zero tolerance for harassment of any kind
- First Contributions Tutorial - A hands-on tutorial for making your first contribution
- GitHub's Hello World Guide - Learn GitHub basics
- How to Contribute to Open Source - Comprehensive guide
- Choose a License - Help choosing the right license for your project
All contributors will be recognized in our README.md file. Thank you for your contributions! 🎉
A big thank you to all our contributors! Your efforts make this project possible.
If you have any questions or need help, feel free to:
- Open an issue in this repository
- Reach out to the maintainers
- Check existing issues and discussions
Remember to star this repository ⭐ if you had fun contributing!
Celebrate Open Source! Every contribution, no matter how small, makes a difference. Welcome to the community! 🎃
Name: Anmol Agarwal
- Place: Delhi, India
- Bio: Full Stack Developer and Open Source Enthusiast
- GitHub: fineanmol