CONTRIBUTING.md

Contributing to SOQL Lib

Thank you for considering contributing to the SOQL Lib project! 🙌
We welcome contributions that improve performance, add features, fix bugs, or enhance documentation and tests.

🚀 How to Contribute

To contribute to this project, please follow the standard GitHub fork-and-pull workflow:

1. Fork the Repository

Start by forking the repository to your own GitHub account.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/soql-lib.git
cd soql-lib

3. Create a New Branch

git checkout -b feature/my-awesome-feature

4. Make Your Changes

Make your changes in the appropriate files. Please follow the current coding style and conventions used in the codebase.

If you’re updating logic, add or update unit tests.

5. Commit and Push

git add .
git commit -m "feat: add support for XYZ feature"
git push origin feature/my-awesome-feature

6. Open a Pull Request

Open a Pull Request (PR) from your fork to the main branch of the original repository:

https://github.com/beyond-the-cloud-dev/soql-lib

• Base: main
• Compare: your feature branch

Add the code example to the PR description.

7. Add Reviewer

Please add @pgajek2 as a reviewer to your PR.

✅ Pull Request Checklist

Before submitting your PR, make sure you’ve:

• Written clear and concise commit messages
• Followed existing code style and naming conventions
• Added or updated relevant documentation (if applicable)
• Added or updated unit tests (if applicable)
• Verified that all existing tests pass