Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (81 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

116 lines (81 loc) · 3.58 KB

Here's an adapted version of your CONTRIBUTING guide for the Build-your-own-Git-opensource repository:

Contribute to Build‑your‑own‑Git‑opensource 🛠️

Welcome aboard! Your contributions, big or small, help improve this project.

🚀 Getting Started

New to Git or GitHub? No problem! Here are some useful resources:

✨ First Pull Request

  1. ⭐ Star this repo.

  2. 🍴 Fork the repository to your account.

  3. 💻 Clone your fork:

    git clone https://github.com/<your-username>/Build-your-own-Git-opensource.git

  4. 📁 Enter the project directory:

    cd Build-your-own-Git-opensource

  5. 🚧 Create a new branch:

    git checkout -b feature/your-feature-name

  6. ✏️ Make your changes.

  7. ➕ Stage your changes:

    git add .

  8. 📝 Commit with a clear message:

    git commit -m "Add <feature>: brief description"

  9. 🆙 Push to your fork:

    git push -u origin feature/your-feature-name

  10. 🔁 Create a Pull Request on GitHub.

  11. 🎉 Celebrate — you just contributed!

✅ Alternative: GitHub Desktop

  1. Open GitHub Desktop and sign in.
  2. Clone the repository via “File → Clone Repository.”
  3. Switch to your branch or create a new one.
  4. Make edits in your code editor.
  5. Commit in GitHub Desktop, adding a summary and description.
  6. Push your changes using the “Push origin” button.
  7. Open a Pull Request via the GitHub website.

💡 Best Practices

  • Code style: Follow the existing format with clean, readable code.
  • Descriptive names: Use clear names for functions, variables, and test cases.
  • Keep it DRY: Avoid repeating code by refactoring shared logic.
  • Comment wisely: Document why things are done (not just what).
  • Write tests: Cover expected behavior and edge cases. Run them locally.
  • Peer review: Review others’ PRs and provide constructive feedback.

🔄 Pull Request Process

When opening a PR:

  1. ✅ Self-review first.
  2. ✍️ Explain what you've added or changed.
  3. 🛠️ Comment on complex code to help reviewers.
  4. 📸 Include screenshots if applicable.
  5. 🧰 Use the PR template provided.
  6. 🕒 Be patient — review might take a little time.

🐛 Issues

To report a bug or request a feature:

  1. Go to the Issues page.
  2. Provide a concise title and detailed description.
  3. Avoid duplicate reports—search existing issues first.
  4. Wait for maintainers to respond before starting work.

🙏 A Note from the Maintainers

We welcome contributions from everyone, but please avoid spammy or irrelevant issues and PRs. We may close those that don't align with the project's goals.

We can’t wait to see what you build! If you have any questions or feedback, feel free to reach out via GitHub issues or contact the maintainer 😊