Skip to content

Contributing to SimpleORM

First off, thanks for taking the time to contribute! 🙏

We welcome all contributions to SimpleORM — whether it's fixing bugs, adding features, improving documentation, or suggesting ideas.

📜 How to Contribute

  1. Fork the repository
  2. Clone your fork 
    git clone https://github.com/yourusername/simpleorm.git
  3. Create a new branch for your feature or fix 
    git checkout -b your-feature-branch
  4. Make your changes and commit them with clear messages 
    git commit -m "Add feature X"
  5. Push to your fork 
    git push origin your-feature-branch
  6. Create a Pull Request (PR) to the main branch

🧹 Code Style

  • Follow PEP8 style guide for Python.
  • Write clear, simple, and documented code.
  • Type hints are encouraged for public methods.
  • Add docstrings to new functions and classes.

🧪 Testing

We love code that doesn’t break!
If possible:

  • Add unit tests for any new features or bug fixes.
  • Ensure all tests pass before opening a Pull Request.
  • To run tests locally: 
        pytest

🏷 Good First Issues

If you're new and want something easy to start with, check out:
👉 Good First Issues

We have tasks that are perfect for first-time contributors!

🛡 Code of Conduct

We follow the Contributor Covenant Code of Conduct.
Please be kind, respectful, and constructive.

🙌 Thank You!

Your contributions make SimpleORM better for everyone.
Every PR, issue, and suggestion is deeply appreciated.

Let's build something simple and powerful together! 🚀