Skip to content

Add Github PR template#595

Open
mikekryjak wants to merge 1 commit into
masterfrom
pr-template
Open

Add Github PR template#595
mikekryjak wants to merge 1 commit into
masterfrom
pr-template

Conversation

@mikekryjak

Copy link
Copy Markdown
Collaborator

Purpose

Adds a template for pull requests. The template consists of 6 headings with commented guidelines under each one.

Change Summary

Added .github/PULL_REQUEST_TEMPLATE.md

Validation

Not actually sure if it's possible without merging the PR first, since it's a Github thing! For this PR, I copy pasted the template manually.

AI Assistance

An LLM reviewed the template and came up with the HTML comment format.

Documentation

None, since it's self-explanatory. I hope.

Review Notes

Please let me know if you agree with the headings and comments, and whether you think it's easy on the eyes. I'm wondering whether using smaller headings would be better.

@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.09%. Comparing base (d66b56c) to head (d11564c).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #595   +/-   ##
=======================================
  Coverage   49.09%   49.09%           
=======================================
  Files          96       96           
  Lines       10037    10037           
  Branches     1452     1452           
=======================================
  Hits         4928     4928           
  Misses       4604     4604           
  Partials      505      505           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

<!-- How did you verify this works? Include relevant tests, manual checks, or analysis. If not tested, say why. -->

## AI Assistance
<!-- Were AI tools used during development? If yes, briefly describe how, and how you verified their output. -->

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- Were AI tools used during development? If yes, briefly describe how, and how you verified their output. -->
<!-- Were AI tools used during development? If yes, briefly describe how, and how you verified their output. Remove this section if your PR does not contain AI-generated content. -->

Taken from: https://github.com/pydata/xarray/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants