Skip to content

param3026/HacktoberFest-2021

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

118 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🎉 HacktoberFest 2021 — Beginner-Friendly Contributions

GitHub issues Pull Requests Contributors Contributions Welcome License: MIT


Welcome to HacktoberFest 2021 — a friendly repo to help beginners make their first open‑source contributions. This file is tailored for the repository keshavsingh3197/HacktoberFest-2021 and is ready to copy & paste into that project as README.md.

Friendly, well-structured repos help beginners succeed. Let’s make contributing clear, fast, and fun.


📌 Table of Contents


❓ About

This repository collects beginner-friendly programs, algorithms, and small projects across different programming languages. It is intended for learning, practicing Git/GitHub workflows, and celebrating HacktoberFest by making valid contributions.

Contributions can include:

  • New algorithms or problem solutions
  • Small utilities or scripts
  • Documentation improvements and examples
  • Fixes to existing programs

🤝 Why contribute here?

  • Beginner-focused: reviewers provide encouraging, constructive feedback.
  • Multi-language: add solutions in the language you know.
  • Low barrier: small, meaningful PRs are welcome and reviewed.

🛠 How to contribute (quick)

  1. Fork this repository
  2. Clone your fork locally
  3. Create a branch: git checkout -b feat/<short-description>
  4. Add your solution inside the correct language folder
  5. Commit, push, and open a Pull Request

Full instructions are below.


📏 Rules & quality expectations

Please follow these to keep the project useful for learners:

  1. Place files in the correct language folder. See the folder list below.
  2. File naming: be descriptive and unique. Example: binary_search_python.py or linked_list.cpp.
  3. Small, meaningful PRs only. Large dumps or archive uploads will be closed.
  4. Add comments explaining logic and expected input/output where applicable.
  5. No plagiarized or copy‑pasted entire repo content from other large projects.
  6. No single-line PRs that add no value (these will be marked invalid).
  7. Include a short explanation in your PR description: what you added and why.
  8. Follow basic style for the language (PEP8 for Python, reasonable formatting for C/C++/Java, etc.)

If a PR does not meet these guidelines a reviewer will request changes or close it as invalid.


🗂 Folder structure & naming conventions

Suggested structure (create missing folders as needed):

HacktoberFest-2021/
├─ C++/
├─ Python/
├─ Java/
├─ JavaScript/
├─ Web-Development/
├─ Algorithms/
├─ Data-Structures/
└─ README.md

Naming conventions:

  • problemname_language.extensionfibonacci_python.py
  • If multiple files needed (input/test) add a short suffix: merge_sort_cpp.cpp, merge_sort_cpp_test.cpp

Folder purpose guidance:

  • Algorithms/ — language-agnostic algorithm explanations and pseudocode
  • Data-Structures/ — implementations of classic data structures
  • Web-Development/ — small web-page projects or examples

✅ How to open a Pull Request (detailed)

  1. Fork the repo (top-right of the repo page)
  2. Clone your fork:
git clone https://github.com/<your-username>/HacktoberFest-2021.git
cd HacktoberFest-2021
  1. Create a feature branch (never commit directly to master/main):
git checkout -b feat/add-<short-description>
  1. Add your file in the correct folder. Include comments and a short example of usage (input / output) in the file header or as README changes.

  2. Stage, commit, push:

git add .
git commit -m "Add <program-name> in <language> - <short description>"
git push origin feat/add-<short-description>
  1. Open a Pull Request from your fork → this repository. Use a helpful PR title and fill the description with:
  • What the code does
  • Example usage and sample input/output
  • Any dependencies or runtime requirements
  1. Wait for review. A maintainer or reviewer may suggest changes. Please respond politely and update your PR.

🌟 Good First Issues

Look for issues labeled good first issue or help wanted. These are curated for beginners—try one to gain confidence. If none exist, open a small PR (documentation, small algorithm) and request review.


🧑‍🤝‍🧑 Community & Code of Conduct

This project aims to be inclusive and welcoming. Please be respectful and constructive. For serious projects, add or link a full CODE_OF_CONDUCT.md. If maintainers haven’t added one, treat interactions with kindness and assume best intent.


📜 License

This repository uses the MIT License.

Add a LICENSE file with MIT text if not present. By contributing you license your contribution under MIT.


⚙️ Maintainers

Primary repo: keshavsingh3197/HacktoberFest-2021 If you are the owner and want to be shown as the maintainer, update the Maintainers section below.

Maintainers:

  • keshavsingh3197 (owner)

🚀 Next steps (recommended)

  1. Add this README.md to the repo root (replace existing README).
  2. Add CONTRIBUTING.md, PR/Issue templates, and CODE_OF_CONDUCT.md to reduce spam and set expectations.
  3. Optionally add a simple CI check to detect empty or one-line PRs.

Thanks for making open-source easier for beginners — have fun and happy hacking!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors