Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
156 lines (97 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

156 lines (97 loc) · 4.1 KB

Contributing to Beginner Python Mini Projects – Hacktoberfest 2025

Hacktoberfest Logo Vertical

Thank you for your interest in contributing to the Beginner Python Mini Projects Hacktoberfest 2025! This guide will help you understand how to get involved, what kinds of contributions are welcome, and how to make the most out of your Hacktoberfest journey.

How to Contribute

We welcome both new mini-project ideas and contributions to existing issues. Here’s how to start:

1. Fork the Repository

Forking will create a copy of this repo under your GitHub account where you can safely make changes.

📎 Click here to fork

2. Clone the Repository

Clone your forked repository to your local machine:

git clone https://github.com/<your-username>/beginner-python-mini-projects-hacktoberfest-2025.git
cd beginner-python-mini-projects-hacktoberfest-2025

Replace <your-username> with your GitHub handle.

3. Work on Your Contribution

You can contribute in one of two ways:

✅ Option A: Work on an Existing Issue

  • Go to the Issues tab.
  • Find an open issue that interests you.
  • Comment with I'd like to work on this. and wait to be assigned.
  • Once assigned, start working and follow the folder format described below.

💡 Option B: Add Your Own Mini Project

  • Come up with a creative beginner-friendly Python project.

  • Create a new folder in src/ using this format:

    src/yourgithubusername-project-title/

Example:

src/janedoe-weather-app/

Inside that folder, include:

  • Your .py files
  • A README.md file with setup and usage instructions
  • Optional: requirements.txt for dependencies

4. Create a Pull Request

Once your project is complete and tested:

  1. Stage and commit your changes:

    git add .
git commit -m "Add janedoe-weather-app mini project"

  2. Push to your fork:

    git push origin main

  3. Go to your GitHub repo and click on Compare & pull request.

In your PR description:

  • Mention whether this is a new project or tied to an existing issue.
  • Briefly describe what the project does and any special features.

Contribution Guidelines

✅ Project Format

All submissions must follow this directory format:

src/
  yourgithubusername-projectname/
    ├── main.py
    ├── README.md
    ├── (any other files like images, helpers, etc.)
    └── requirements.txt (if needed)

Do not place files directly inside src/. Always use your own uniquely named folder.

✅ Code Quality

  • Keep code beginner-friendly and well-commented.
  • Use meaningful variable and function names.
  • Avoid unnecessary dependencies.

✅ Documentation

Each project must include a README.md with:

  • Project title and brief description
  • Steps to run it locally
  • Any required dependencies (or include a requirements.txt)
  • Screenshots or demo (optional, but appreciated!)

Pull Request Review Process

Once you submit a pull request:

  1. A maintainer will review your PR for structure, clarity, and functionality.
  2. You may receive comments or change requests—please respond and push updates.
  3. Once everything looks good, your PR will be merged into the repo.

We try to review PRs quickly, especially during Hacktoberfest, but please be patient.

Reporting Issues

See something wrong? Want to suggest a new project idea or spot a bug? Open an issue!

👉 Create an Issue

Use the templates available to:

  • Report a bug
  • Suggest a new feature
  • Ask for help

Thank you for contributing to Beginner Python Mini Projects – Hacktoberfest 2025! We’re excited to see what you’ll build. Let’s make this Hacktoberfest fun, inclusive, and beginner-friendly for everyone!

Happy hacking! 💻🎉