Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (42 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 1.37 KB

Contributing to PostgreSQL Playground

Thank you for your interest in contributing to this project! 🎉

We welcome all contributions including bug reports, feature requests, and pull requests.

📝 How to Contribute

1. Fork the Repository

Click the Fork button at the top of the repository page to create your own fork.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/postgresql-playground.git
cd postgresql-playground

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

Edit the code, write tests if relevant, and make sure everything works.

5. Commit and Push

git add .
git commit -m "Add: your message here"
git push origin feature/your-feature-name

6. Open a Pull Request

Go to your forked repo on GitHub, and click Compare & Pull Request.
Provide a clear description of your changes.

✅ Code Style

  • Follow PEP8 for Python.
  • Use clear, descriptive commit messages.
  • Leave helpful comments in code where necessary.

📦 Setting Up Locally

Make sure Docker and Docker Compose are installed. Then:

docker-compose up --build

Visit http://localhost:8080 in your browser.

🙌 Need Help?

If you have questions or need help, feel free to open an issue or contact the maintainer.

Thanks again!