diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..11b27377 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +## What does this PR do? + + + +Fixes #\ + + + +
+ Before submitting + +- Was this **discussed/agreed** via a GitHub issue? (not for typos and docs) +- [ ] Did you read the [contributor guideline](https://adalflow.sylph.ai/contributor/index.html)? +- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together? +- Did you make sure to **update the documentation** with your changes? (if necessary) +- Did you write any **new necessary tests**? (not for typos and docs) +- [ ] Did you verify new and **existing tests pass** locally with your changes? +- Did you list all the **breaking changes** introduced by this pull request? + + +
+ + + diff --git a/docs/source/contributor/contribution.rst b/docs/source/contributor/contribution.rst index 83509b8a..9343a304 100644 --- a/docs/source/contributor/contribution.rst +++ b/docs/source/contributor/contribution.rst @@ -261,6 +261,10 @@ So far, we are still working on the code in the `/benchmarks` directory. We will Part 4: PR & Review Process ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +**Before submitting a PR** + +Ensure you add a checklist. + You are always welcomed to contribute even if you've never participated in open source project before. Here is the basic contribution process: