Let’s build a vibrant, respectful, and collaborative community!
Quick Principles:
✅ Respect 🌱 Inclusivity 🤝 Collaboration 🎉 Enjoy Contributing!
- ✅ Respect everyone: Kindness and consideration matter.
- 🌱 Embrace inclusivity: Diversity is our strength.
- 🤝 Collaborate openly: Knowledge grows when shared.
- 🎉 Contribute with joy: Have fun and make a difference!
🔗 Fork the repo and 💻 clone locally: git clone https://github.com//AlgoVisualizer.git cd AlgoVisualizer
⚙️ Install dependencies:
npm install
If you encounter a bug or want to request a feature, please open an issue on the Issues page.
Include:
- 📝 A clear, descriptive title
- 📋 Steps to reproduce
- 📷 Screenshots or error messages
- ✏️ Use clear, descriptive variable names
- 💬 Comment thoughtfully where helpful
- 🔄 Fetch latest changes before new work: git fetch upstream git checkout master git merge upstream/master
- 🌿 Create a new branch for each feature/bugfix: git checkout -b feature/your-feature-name
- 📰 Write meaningful commit messages like:
- Add: new feature description
- Fix: bug description
- Docs: update documentation
- 🔄 Update your fork: git fetch upstream git merge upstream/master
- ⬆️ Push your feature branch: git push origin feature/your-feature-name
- Compare & Pull Request on GitHub.
- Fill in a clear description.
- Wait for review and make requested changes.
- Code follows style guidelines
- Necessary comments are added
- Tested in browser
- Branch updated with upstream/master
- Clear commit messages
| Icon | Principle | Description |
|---|---|---|
| ✅ | Respect | Value all contributors and their input |
| 🌱 | Inclusivity | Create a welcoming, diverse environment |
| 🤝 | Collaboration | Work together and support each other |
Your contributions make AlgoVisualizer better for everyone! 💙
