Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (105 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

171 lines (105 loc) · 3.15 KB

Contributing Guide 🤝

Welcome! 🎉

Thank you for your interest in contributing to Open Source Practice Lab. This repository is designed to help beginners learn real open source workflows in a safe and friendly environment.

You do not need permission or assignment to start contributing.

🧠 Who Can Contribute?

Anyone can contribute:

  • Students
  • Beginners in programming
  • Developers new to open source
  • Anyone who wants to practice Git & GitHub

No prior open source experience is required.

📌 How to Contribute (Step-by-Step)

Follow these steps carefully:

1️⃣ Fork the Repository

Click the Fork button at the top-right corner of this repository.

2️⃣ Clone Your Fork

git clone https://github.com/Abhi-2516/Open-Source-Practice-Lab
cd open-source-practice

3️⃣ Create a New Branch

Always create a new branch for each task:

git checkout -b solve-task-name

✅ Example branch names:

  • solve-js-filter-array
  • solve-python-count-vowels
  • fix-html-profile-task

4️⃣ Choose a Task

  1. Open the tasks/ folder
  2. Select a technology (HTML, CSS, JavaScript, React, Python, C++)
  3. Choose a difficulty level: easy, medium, or hard
  4. Open any task file
  5. Read the instructions inside the file carefully

Each task file contains:

  • Problem description
  • TODO comments
  • Expected behavior or output

5️⃣ Solve the Task

  • Write clean and readable code
  • Follow the instructions in the task file
  • Do not remove comments or problem statements
  • Modify only the task file you are solving

6️⃣ Commit Your Changes

Stage and commit your work:

git add .
git commit -m "Solve: <task-name>"

✅ Good commit messages:

  • Solve: filter numbers between 10 and 20
  • Solve: count vowels in a string

7️⃣ Push to Your Fork

git push origin solve-task-name

8️⃣ Open a Pull Request (PR)

  1. Go to your fork on GitHub
  2. Click Compare & Pull Request
  3. Add a short, clear description of what you solved
  4. Submit the Pull Request

🎉 That’s your open source contribution!

📏 Contribution Rules

Please follow these rules strictly:

  • ✅ One task per Pull Request
  • ❌ Do not solve multiple tasks in one PR
  • ❌ Do not change unrelated files
  • ❌ Do not rename or delete task files
  • ✅ Keep code clean and understandable
  • ✅ Be respectful in discussions

PRs that do not follow these rules may be requested for changes.

🔄 After You Open a PR

  • Maintainers will review your PR
  • You may be asked to make improvements
  • If changes are requested, commit to the same branch
  • Do not close the PR unless asked

Once approved, your PR will be merged 🎉

💬 Need Help?

If you are stuck:

  • Re-read the task instructions
  • Check similar solved tasks
  • Ask questions politely in the PR comments

Remember: Everyone starts somewhere.

🌱 Want to Do More?

You can also:

  • Add new tasks
  • Improve existing task descriptions
  • Suggest new technologies

Open a Pull Request with clear details.

✨ Happy contributing and welcome to open source! 🚀