DataFed
DataFed copied to clipboard
[TASK] Update pull_request_template.md
P## Ticket
None
Description
Want to update the PR template 💪
How Has This Been Tested?
N/A
Artifacts (if appropriate):
N/A
Summary by Sourcery
Update the repository’s pull request template with standardized sections for ticket references, detailed change descriptions, testing steps, artifacts, and a tasks checklist
Documentation:
- Add “Ticket” section with link placeholder
- Add “Description” section with detailed change prompt
- Add “How Has This Been Tested?” section for testing details
- Add “Artifacts” section for images or videos
- Replace generic tasks header with a checklist enforcing PR description and formatter run
Reviewer's Guide
This PR restructures the GitHub pull request template by introducing dedicated headings for ticket, description, testing, artifacts, and updates the tasks checklist for clarity and consistency.
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Revamped section structure and placeholders |
|
.github/pull_request_template.md |
| Added standardized task checklist |
|
.github/pull_request_template.md |
Tips and commands
Interacting with Sourcery
-
Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
-
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. -
Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. -
Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. -
Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. -
Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. -
Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.