Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
155 lines (117 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

155 lines (117 loc) · 4.86 KB
Raw

🤗 Welcome to AlgoVisualizer!

Let’s build a vibrant, respectful, and collaborative community!
Quick Principles:
✅ Respect 🌱 Inclusivity 🤝 Collaboration 🎉 Enjoy Contributing!

Welcome GIF

🎖️ Badges

Contributions Welcome
Good First Issue
Open Source Love
Hacktoberfest
PRs Welcome

✨ Summary

  • ✅ 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!

Getting Started GIF

🚀 Getting Started

1. Fork & Clone the Repository

🔗 Fork the repo and 💻 clone locally:

git clone https://github.com/<your-username>/AlgoVisualizer.git
cd AlgoVisualizer

2. Setup Environment

⚙️ Install dependencies:

npm install

▶️ setup API keys:

cp .env.example .env.local

Proceed to SECURITY.md for more details. If you are contributing to backend, visit the AlgoVisualizer Backend for further assistance.

▶️ Start the development server:

npm run dev

Visit http://localhost:5173/ to view the website

If your browser does not render the website, try opening the link in Chrome browser

3. Create a new branch:

git checkout -b feat/my-feature

4. Make your changes and commit:

git add .
git commit -m "feat: describe your change"

5. Push your branch:

git push origin feat/my-feature

6.Create a Pull Request on GitHub and describe what you’ve done.

Head to your forked repository and create a Pull Request. Congratz you've contributed to this project! Setup GIF

🐛 Reporting Issues

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

📌 Coding Standards

  • ✏️ 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

🔀 Submitting Pull Requests

  1. 🔄 Update your fork: 
    git fetch upstream
git merge upstream/master
  2. ⬆️ Push your feature branch: 
    git push origin feature/your-feature-name
  3. Compare & Pull Request on GitHub.
  4. Fill in a clear description.
  5. Wait for review and make requested changes.

📝 Contribution Checklist

  • Code follows style guidelines
  • Necessary comments are added
  • Tested in browser
  • Branch updated with upstream/master
  • Clear commit messages

Core Values GIF

🌍 Our Core Values

Icon Principle Description
✅ Respect Value all contributors and their input
🌱 Inclusivity Create a welcoming, diverse environment
🤝 Collaboration Work together and support each other

🎉 Thank You

Your contributions make AlgoVisualizer better for everyone! 💙

Thank You GIF