Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (77 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

108 lines (77 loc) · 2.95 KB

Contributing to SnapMap 🚀

Thank you for your interest in contributing to SnapMap! Contributions are always welcome and appreciated. Please read this guide carefully before starting, as PRs not following these rules may not be reviewed or accepted.

📌 Before You Start

  • Go through the README.md to understand the project.
  • Check the Issues section and claim an issue before starting work.
  • If something is unclear or no contribution guide exists for a specific feature, clarify with the mentors first.

🛠️ Steps to Contribute

1️⃣ Fork the Repository

  • Fork the SnapMap repository to your GitHub account.
  • Clone your fork locally: 
    git clone https://github.com/<your-username>/SnapMap.git
  • Navigate to the project directory: 
    cd SnapMap

2️⃣ Create a Branch (if required)

Some issues may require working on a separate branch.

git checkout -b feature/<short-description>

Follow the branch naming convention if mentioned in the issue.

3️⃣ Make Your Changes

  • Write clean, readable, and well-documented code.
  • Ensure your changes solve only the issue you’re working on.
  • Test your changes locally before pushing.

4️⃣ Commit Your Changes

Write meaningful commit messages:

git commit -m "Fix: <short description of change>"

5️⃣ Open a Pull Request (PR) ✅

Once you’re confident with your implementation:

  • Push your changes to your fork: 
    git push origin feature/<short-description>
  • Open a PR from your fork to the main SnapMap repository.

🔴 Mandatory PR Rules

Failure to follow these WILL result in points not being awarded, even if the PR is merged.

  • ✅ You must fork the repo before contributing.
  • ✅ Ensure there are no merge conflicts.
  • ✅ PR title must be clear and relevant.
  • ✅ The first line of the PR description MUST contain: 
    Issue : #<issue_number>
    (The # is mandatory)

🤖 PR Validation Bot

  • If your PR follows the template correctly, you’ll receive a “Valid PR” message from our GitHub bot.
  • If the PR is invalid, the bot will warn you and request changes.
  • Modify the same PR to fix issues — do NOT close and open a new PR unless a mentor asks you to.

🔁 Making Changes After Review

  • If a mentor requests changes:
    • Update your code in the same PR.
    • Push additional commits to that PR.
  • Closing and reopening PRs without permission may lead to confusion for you and maintaner.

✅ PR Merge & Points

  • Once the mentor is satisfied, your PR will be merged.
  • A successful merge earns you points on the Leaderboard🎉

📢 Need Help?

  • Reach out to mentors if you have some confusion, query.
  • Be respectful and patient during reviews and merges.

Happy contributing to SnapMap! 🌍 Welcome to OpenCode 2025✨