Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update PULL_REQUEST_TEMPLATE.md #37

Closed
wants to merge 2 commits into from
Closed

Update PULL_REQUEST_TEMPLATE.md #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ebac75
Update PULL_REQUEST_TEMPLATE.md
Burhan-Q Jan 6, 2024
33900c1
add discussion sub-section
Burhan-Q Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 92 additions & 7 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,98 @@
Thank you 🙏 for your contribution to [Ultralytics](https://ultralytics.com) 🚀! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:
<!--
Thank you 🙏 for your contribution to Ultralytics 🚀! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, fill out all relevant sections
-->

1. **Check for Existing Contributions**: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.
> [!TIP]
> Select **only one** of the below options

2. **Link Related Issues**: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.
- [ ] BUG FIX
- [ ] ADD FEATURE

3. **Elaborate Your Changes**: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.
# Summary of Changes

4. **Ultralytics Contributor License Agreement (CLA)**: To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:
<!-- Briefly summarize fixes or additions -->

## Link Issues

<!-- BUG FIX (required)
Reference an open Issue here.

If this PR doesn't address an open Issue, please open one before submitting the PR.
Use the Issue to provide supporting evidence or citations for the bug or fix.

-->

### Relevant Discussions

<!--
Add reference links to any Community Discussions relevant to changes made in this PR.
-->

## Rationale/Justification

<!-- ADD FEATURE (required)
Outline justification for feature to be added and provide references/citations to any relevant evidence, publications, or standards.
-->

## Changes made

<!-- Add bullet list of changes -->

-
-
-

## Checklist

<!-- Only PRs where author has completed all outlined items will be reviewed. Marking these as complete without actually completing them will not help your case, please do not attempt this at it will waste time. -->

- [ ] BUG FIX :: I have added a link to _at least_ **one** open Issue.
- [ ] ADD FEATURE :: I have provided justification / rationale for adding new feature(s).
- [ ] I have reviewed the Ultralytics [Contributing Guide and Best Practices](https://docs.ultralytics.com/help/contributing).
- [ ] I have verified that this PR includes the most recent changes from the default branch.
- [ ] All repository checks/tests are passing for the final commit.
- [ ] I have thoroughly reviewed and tested my code changes and verify that I'm not aware of any breaking changes this PR introduces.

> [!IMPORTANT]
> To uphold the quality and integrity of our project, we require all contributors to sign the **Ultralytics Contributor License Agreement (CLA)**.
- [ ] Add comment to PR _I have read the CLA Document and I hereby sign the CLA_

## Known/lingering Problems

<!-- Include list of any known or potential lingering problems that this PR doesn't address or have not been tested. -->

-
-
-

## Relevant media (optional)

<!-- Add relevant media (optional) under each sub-section -->

<details><summary>{DESCRIBE MEDIA HERE}</summary>
<p>

<!-- Replace this line with media -->

![Example image](https://github.com/raw/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg)

</p>
</details>

## Results (optional)

<!-- Include table formatted results if relevant -->

<details><summary>{TABLE-1}</summary>
<p>

| A | B | C | D |
|---|---|---|---|
| 0 | | | |
| 1 | | | |
| - | - | - | - |

</p>
</details>

_I have read the CLA Document and I hereby sign the CLA_

For more detailed guidance and best practices on contributing, refer to our ✅ [Contributing Guide](https://docs.ultralytics.com/help/contributing). Your adherence to these guidelines ensures a faster and more effective review process.