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.
-
Do NOT include
node_modules/in your pull requests. Addnode_modules/to.gitignoreif not already present. -
Always create a new branch for your pull requests (PRs). Example:
git checkout -b feature/your-feature-name
- 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.
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.
- Test your feature locally before submitting a PR.
- Make sure it doesn’t break any existing functionality.
-
Fork this repo.
-
Create a branch from
mainordev:git checkout -b feature/your-feature-name
-
Make your changes.
-
Commit and push:
git commit -m "Add: [your feature name]" git push origin feature/your-feature-name -
Open a PR to the main repository with a clear description, images, and video (if applicable).
- Don’t commit large/irrelevant files (like
node_modules,.env, etc.) - Don’t make PRs from your
mainbranch.
Let’s build something awesome together! 🚀