Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
127 lines (67 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

127 lines (67 loc) · 2.1 KB

🤝 Contributing to learn-git-github

First of all, thank you for considering contributing to learn-git-github 🎉
This project exists to help beginners learn Git & GitHub the right way.

We welcome all kinds of contributions, especially from first-time contributors.

🧠 Who Can Contribute?

  • Beginners learning Git & GitHub
  • Students & open-source newcomers
  • Developers who want to improve explanations
  • Anyone who wants to help others learn

No contribution is too small 🙌

🛠️ Ways to Contribute

You can contribute by:

  • Fixing typos or grammar
  • Improving explanations
  • Adding examples or screenshots
  • Adding common Git mistakes & fixes
  • Improving folder structure
  • Translating content

🚀 How to Contribute (Step-by-Step)

1️⃣ Fork the Repository

Click the Fork button on the top-right of this repository.

2️⃣ Clone Your Fork

git clone https://github.com/<your-username>/learn-git-github.git
cd learn-git-github

3️⃣ Create a New Branch

git checkout -b fix-issue-name

Example:

git checkout -b fix-typo-readme

4️⃣ Make Your Changes

  • Edit files
  • Add new content
  • Follow simple & beginner-friendly language

5️⃣ Commit Your Changes

git add .
git commit -m "Fix: improved README explanation"

6️⃣ Push to Your Fork

git push origin fix-issue-name

7️⃣ Create a Pull Request (PR)

  • Go to your fork on GitHub
  • Click Compare & Pull Request
  • Describe what you changed
  • Submit the PR 🎉

✅ Contribution Guidelines

  • Keep explanations simple & beginner-friendly
  • Avoid advanced Git concepts unless explained clearly
  • Use clear commit messages
  • One feature or fix per PR

🧪 Testing

This is a documentation-based project. Please ensure:

  • Commands are correct
  • Steps are reproducible on Windows

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.

❤️ Thank You

Your contribution helps beginners gain confidence with Git & GitHub.

Happy contributing! 🚀