Skip to content

Commit

Permalink
add the pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
liyin2015 committed Nov 17, 2024
1 parent ce37b42 commit 10c8bb0
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## What does this PR do?

<!--
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
The following links the related issue to the PR (https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
-->

Fixes #\<issue_number>

<!-- Does your PR introduce any breaking changes? If yes, please list them. -->

<details>
<summary><b>Before submitting</b></summary>

- 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?


</details>


<!--
Did you have fun?
Make sure you had fun coding 🙃
-->
4 changes: 4 additions & 0 deletions docs/source/contributor/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 10c8bb0

Please sign in to comment.