Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 1.84 KB

File metadata and controls

74 lines (46 loc) · 1.84 KB

🤝 Contributing Guide

Thank you for considering contributing to this project! We welcome your ideas, suggestions, and improvements. Before you begin, please read the guidelines below to keep everything organized and consistent.


📁 Project Setup Guidelines

  • Do NOT include node_modules/ in your pull requests. Add node_modules/ to .gitignore if not already present.

  • Always create a new branch for your pull requests (PRs). Example:

    git checkout -b feature/your-feature-name

✅ Best Practices for Contributions

  • Write clean, readable code and follow the project's coding conventions.
  • Use clear and descriptive commit messages.
  • Try to make PRs focused on a single change/feature.

📸 Feature Documentation

Whenever you add a new feature, please include:

  • 🖼️ At least one image (e.g., a screenshot or UI snippet).
  • 🎥 A short video demo (GIFs or screen recordings are great).

You can upload these to GitHub directly or use tools like Loom or Gyazo.


🧪 Testing & Validation

  • Test your feature locally before submitting a PR.
  • Make sure it doesn’t break any existing functionality.

🔀 Submitting a Pull Request

  1. Fork this repo.

  2. Create a branch from main or dev:

    git checkout -b feature/your-feature-name
  3. Make your changes.

  4. Commit and push:

    git commit -m "Add: [your feature name]"
    git push origin feature/your-feature-name
  5. Open a PR to the main repository with a clear description, images, and video (if applicable).


🚫 Things to Avoid

  • Don’t commit large/irrelevant files (like node_modules, .env, etc.)
  • Don’t make PRs from your main branch.

Let’s build something awesome together! 🚀