|
| 1 | +# Contributing to SOQL Lib |
| 2 | + |
| 3 | +Thank you for considering contributing to the **SOQL Lib** project! 🙌 |
| 4 | +We welcome contributions that improve performance, add features, fix bugs, or enhance documentation and tests. |
| 5 | + |
| 6 | +## 🚀 How to Contribute |
| 7 | + |
| 8 | +To contribute to this project, please follow the standard GitHub fork-and-pull workflow: |
| 9 | + |
| 10 | +### 1. Fork the Repository |
| 11 | + |
| 12 | +Start by [forking the repository](https://github.com/beyond-the-cloud-dev/soql-lib/fork) to your own GitHub account. |
| 13 | + |
| 14 | +### 2. Clone Your Fork |
| 15 | + |
| 16 | +```bash |
| 17 | +git clone https://github.com/YOUR_USERNAME/soql-lib.git |
| 18 | +cd soql-lib |
| 19 | +``` |
| 20 | +### 3. Create a New Branch |
| 21 | + |
| 22 | +```bash |
| 23 | +git checkout -b feature/my-awesome-feature |
| 24 | +``` |
| 25 | + |
| 26 | +### 4. Make Your Changes |
| 27 | + |
| 28 | +Make your changes in the appropriate files. Please follow the current coding style and conventions used in the codebase. |
| 29 | + |
| 30 | +If you’re updating logic, add or update unit tests. |
| 31 | + |
| 32 | +### 5. Commit and Push |
| 33 | + |
| 34 | +```bash |
| 35 | +git add . |
| 36 | +git commit -m "feat: add support for XYZ feature" |
| 37 | +git push origin feature/my-awesome-feature |
| 38 | +``` |
| 39 | + |
| 40 | +### 6. Open a Pull Request |
| 41 | + |
| 42 | +Open a Pull Request (PR) from your fork to the main branch of the original repository: |
| 43 | + |
| 44 | +``` |
| 45 | +https://github.com/beyond-the-cloud-dev/soql-lib |
| 46 | +``` |
| 47 | + |
| 48 | +- Base: `main` |
| 49 | +- Compare: your feature branch |
| 50 | + |
| 51 | +Add the code example to the PR description. |
| 52 | + |
| 53 | +### 7. Add Reviewer |
| 54 | + |
| 55 | +Please add @pgajek2 as a reviewer to your PR. |
| 56 | + |
| 57 | +## ✅ Pull Request Checklist |
| 58 | + |
| 59 | +Before submitting your PR, make sure you’ve: |
| 60 | +- Written clear and concise commit messages |
| 61 | +- Followed existing code style and naming conventions |
| 62 | +- Added or updated relevant documentation (if applicable) |
| 63 | +- Added or updated unit tests (if applicable) |
| 64 | +- Verified that all existing tests pass |
0 commit comments