πHacktoberfest 2025 & Hacksquad 2025 π
Welcome to Code-Contribution!
This repo is your entry point to Hacktoberfest & Hacksquad β a month-long celebration of open-source and community collaboration π»π.
Whether youβre a beginner writing your first Hello World π£ or an experienced developer adding new features, you belong here.
Contribute, learn, and earn cool swag like T-shirts & stickers ππ.
π Donβt forget to β star this repository to show support!
π What is Hacktoberfest?
Hacktoberfest is an annual event that encourages contributions to open-source projects on GitHub.
Throughout October, developers across the globe collaborate, contribute, and celebrate open source.
Rewards: Contribute 4+ valid pull requests and earn limited edition swag π.
π€ What is Hacksquad?
HackSquad lets you team up with friends or other devs to contribute together.
Instead of competing alone, you collaborate as a squad and climb the leaderboard π.
A fun way to learn, grow, and win together β¨.
π― Why Participate?
β
Learn new programming languages
β
Improve your Git & GitHub skills
β
Contribute to real-world projects
β
Network with a global dev community π
β
Earn swag, stickers, T-shirts & recognition
π οΈ How to Participate
1οΈβ£ Register
2οΈβ£ Fork This Repository
Click the Fork button to create your copy of this repository.
3οΈβ£ Add Your βHello Worldβ
- Navigate to the folder for your language.
- If it doesnβt exist, create it (e.g.
python/,cpp/). - Add your file (
hello_world.py,hello_world.cpp, etc.).
4οΈβ£ Commit & Push
git add .
git commit -m "β¨ Added Hello World in Python"
git push origin my-branch
5οΈβ£ Open a Pull Request
- Go to your fork on GitHub.
- Click Compare & Pull Request.
- Submit your PR π¨.
π§ Steps to Contribute Using Git
Cloning the Repository
- Open a terminal window.
-
Use the
git clonecommand with the URL of your forked repository:git clone https://github.com/your-username/Code-Contribution.git cd Code-Contribution
Creating a New Branch
-
Change into the repository directory:
cd Code-Contribution -
Create a new branch:
git branch new-branch -
Switch to the new branch:
git checkout new-branch
Making Changes
-
Add your changes to the staging area:
git add -A -
Commit your changes with a descriptive message:
git commit -m "Add Hello World in [Language]" -
Push your branch to your forked repository:
git push origin new-branch
Syncing Your Fork
-
Add the upstream repository:
git remote add upstream https://github.com/x0lg0n/Code-Contribution.git -
Fetch the latest changes:
git fetch upstream -
Merge the changes into your local master branch:
git checkout master git merge upstream/master
Creating a Pull Request
- Navigate to your forked repository on GitHub.
- Click the βNew pull requestβ button.
- Provide a descriptive title and summary of your changes.
- Submit the pull request.
π Code Documentation Standards
Why Documentation Matters
Good documentation is essential for:
- Onboarding: Helps new contributors understand the codebase quickly
- Maintenance: Makes code easier to maintain and debug
- Collaboration: Enables effective teamwork
- Learning: Serves as a learning resource for others
- Professionalism: Demonstrates coding maturity and best practices
Documentation Requirements
All code contributions must include:
- File-level documentation - Brief description of the fileβs purpose
- Function/method documentation - Parameters, return values, and examples
- Inline comments - Explanation of complex logic (the βwhyβ, not the βwhatβ)
- Usage examples - At least one working example demonstrating the code
- README updates - Add your contribution to the relevant directory README
Language-Specific Standards
We follow industry-standard documentation practices:
| Language | Standard | Example |
|---|---|---|
| Python | PEP 257 Docstrings | """Brief description.\n\nArgs:\n param: Description\n""" |
| Java | JavaDoc | /** @param name Description */ |
| JavaScript | JSDoc | /** @param {string} name - Description */ |
| C/C++ | Doxygen | /** @brief Description\n@param name Description */ |
| C# | XML Documentation | /// <summary>Description</summary> |
Quick Examples
Python Documentation
def calculate_average(numbers: list) -> float:
"""
Calculate the arithmetic mean of a list of numbers.
Args:
numbers (list): List of numeric values
Returns:
float: The average value
Example:
>>> calculate_average([1, 2, 3, 4, 5])
3.0
"""
return sum(numbers) / len(numbers)
Java Documentation
/**
* Sorts an array using the bubble sort algorithm.
*
* @param arr Array to be sorted (modified in-place)
* @throws NullPointerException if array is null
*
* @example
* <pre>{@code
* int[] nums = {5, 2, 8, 1};
* bubbleSort(nums);
* // nums is now {1, 2, 5, 8}
* }</pre>
*/
public static void bubbleSort(int[] arr) {
// implementation
}
JavaScript Documentation
/**
* Debounces a function call.
*
* @param {Function} func - Function to debounce
* @param {number} delay - Delay in milliseconds
* @returns {Function} Debounced function
*
* @example
* const debouncedSearch = debounce(search, 300);
* debouncedSearch('query');
*/
function debounce(func, delay) {
// implementation
}
Resources
- π CONTRIBUTING.md - Full contribution guidelines with detailed coding standards
- π Python/README.md - Python-specific documentation standards
- β Java/README.md - Java JavaDoc guidelines
- π Javascript/README.md - JSDoc standards for JavaScript
- π§ C/README.md - Doxygen standards for C code
Tools & Best Practices
Using GitHub Copilot
GitHub Copilot can help improve your documentation:
- Generate docstrings: Ask Copilot to add documentation to your functions
- Code review: Use Copilot to identify missing documentation
- Examples: Request example usage code
- Best practices: Ask about language-specific documentation standards
Learn more: Configuring GitHub Copilot for code review
Enhancing Your GitHub Profile
Your contributions here can boost your professional profile:
- β¨ Showcase quality code with excellent documentation
- π Build your portfolio with diverse language examples
- π€ Demonstrate collaboration through meaningful PRs
- π Highlight on resume as open-source experience
Read more: Using your GitHub profile to enhance your resume
ποΈ Repository Structure
Code-Contribution/
βββ .github/ # GitHub templates and workflows
βββ _includes/ # Jekyll includes
βββ _layouts/ # Jekyll layouts
βββ Bash/ # Bash scripts with examples
βββ C/ # C programs with Doxygen docs
βββ C#/ # C# programs with XML docs
βββ C++/ # C++ programs with Doxygen docs
βββ Dart/ # Dart programs
βββ Fortran/ # Fortran programs
βββ Java/ # Java programs with JavaDoc
βββ Javascript/ # JavaScript with JSDoc
βββ Kotlin/ # Kotlin programs
βββ Perl/ # Perl scripts
βββ PHP/ # PHP scripts
βββ Python/ # Python with docstrings
βββ R/ # R scripts
βββ Ruby/ # Ruby programs
βββ Rust/ # Rust programs
βββ Scala/ # Scala programs
βββ Swift/ # Swift programs
βββ CONTRIBUTING.md # Detailed contribution guidelines
βββ LICENSE # Project license
βββ README.md # This file
Each language directory contains:
- π README.md - Language-specific coding standards and examples
- π» Code files - Fully documented example programs
- π Documentation - Following language conventions
Purpose of the Repository
This repository serves as a beginner-friendly gateway to open-source. By contributing here, you can:
- Practice Git & GitHub workflows
- Explore different programming languages
- Make your first open-source PR
- Join the Hacktoberfest & Hacksquad celebration π
Example Contributions
Here are some examples of βHello Worldβ programs in different programming languages:
Python
print("Hello, World!")
JavaScript
console.log("Hello, World!");
C++
#include <iostream>
int main() {
std::cout << "Hello, World!" << std::endl;
return 0;
}
Feel free to explore the repository and see more examples in various languages. Happy contributing!
π¨ Make It Fun β Add Creativity!
You can also:
- Add fun βHello Worldβ in different languages
- Use ASCII art, emojis, or creative formatting π
- Share your experience in PR description
π§βπ» Jekyll Theme
This repository uses the Jekyll theme minima. To run locally:
-
Install Jekyll: Make sure you have Ruby and Bundler installed. Then install Jekyll with the following command:
gem install jekyll bundler -
Clone the repository: If you havenβt already, clone the repository to your local machine:
git clone https://github.com/your-username/Code-Contribution.git -
Navigate to the repository directory:
cd Code-Contribution -
Install dependencies: Install the required dependencies using Bundler:
bundle install -
Run the Jekyll site: Use the following command to build and serve the site locally:
bundle exec jekyll serve -
Open your browser: Open your web browser and go to
http://localhost:4000to see the site.
More information on Jekyll, visit the Jekyll documentation.
β€οΈ Thank You
Hacktoberfest is about community, learning, and fun. Letβs make 2025 the biggest and most engaging yet π₯³.
Hurray!! You just got closer to complete your hacktoberfest challenge.
Purpose of the Repository
The purpose of this repository is to provide a platform for developers to contribute to open-source projects during Hacktoberfest and Hacksquad 2024. By adding a βHello Worldβ program in any programming language, contributors can participate in these events, learn about different programming languages, and collaborate with the community.
How to Contribute
- Fork the repository to your own GitHub account.
-
Clone your forked repository to your local machine:
git clone https://github.com/your-username/Code-Contribution.git -
Create a new branch for your contribution:
git checkout -b feature/your-feature-name -
Add your βHello Worldβ program in the appropriate language directory. If the directory does not exist, create one.
-
Commit your changes with a descriptive commit message:
git commit -m "Add Hello World in [Language]" -
Push your branch to your forked repository:
git push origin feature/your-feature-name -
Open a Pull Request to the main branch of this repository with a descriptive title and summary of your changes.
- Wait for review and approval. Once your pull request is approved, it will be merged into the main branch.
Example Contributions
Here are some examples of βHello Worldβ programs in different programming languages:
Python
print("Hello, World!")
JavaScript
console.log("Hello, World!");
C++
#include <iostream>
int main() {
std::cout << "Hello, World!" << std::endl;
return 0;
}
Feel free to explore the repository and see more examples in various languages. Happy contributing! Happy Contributing π