Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (77 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

114 lines (77 loc) · 2.45 KB

🤝 Contributing to LearnSQL

First of all, thank you for taking the time to contribute to LearnSQL! 🎉

This project is built to help beginners learn SQL in a clear, structured, and practical way — and your contributions can make it even better.

📌 About the Project

LearnSQL is a beginner-friendly SQL documentation website built using React JS and Tailwind CSS.

It focuses on:

  • Clear explanations
  • Proper learning order
  • Easy revision through cheatsheets & practice queries

Whether you’re fixing a typo, improving UI, adding content, or optimizing code — every contribution matters 💙

🛠️ Ways You Can Contribute

You can help LearnSQL by:

  • 📝 Fixing typos or improving explanations
  • 🎨 Enhancing UI/UX or responsiveness
  • 📚 Adding or improving SQL documentation content
  • 🧪 Adding practice queries or examples
  • ⚡ Optimizing React components or code structure
  • 🐛 Fixing bugs or improving performance

🚀 Getting Started

1️⃣ Fork the Repository

Click the Fork button at the top-right of this repository.

2️⃣ Clone Your Fork

git clone https://github.com/TonyStark-19/LearnSQL.git

3️⃣ Navigate to the Project

cd LearnSQL

4️⃣ Install Dependencies

npm install

5️⃣ Start the Development Server

npm run dev

✏️ Making Changes

  • Keep code clean and readable
  • Follow existing project structure
  • Use meaningful commit messages
  • Make sure the site runs without errors

✅ Commit Guidelines

Use clear and descriptive commit messages:

git commit -m "Add practice queries for SQL joins"

Examples:

  • Fix typo in WHERE clause docs
  • Improve responsiveness of docs page
  • Add new SQL practice questions

📋 Pull Request Checklist

Before submitting, please ensure:

  • Code runs without errors
  • Changes follow the existing style
  • No unnecessary files are added
  • Content is beginner-friendly

💬 Need Help?

If you’re unsure about something:

  • Open an Issue
  • Ask questions in the PR description
  • Suggest improvements — ideas are welcome!

❤️ Code of Conduct

Please be respectful and supportive. This project is meant to be a safe and welcoming space for learners.

🙌 Thank You!

Your contribution helps make LearnSQL better for everyone learning SQL. Whether big or small — thank you for your support 🚀