pr_template

[andrewgsavage]

I think this is what is needed for github to give a template when opening a PR

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.59%. Comparing base (57e2a20) to head (b275a53).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #221      +/-   ##
==========================================
- Coverage   95.70%   95.59%   -0.12%     
==========================================
  Files          11       12       +1     
  Lines        1908     1905       -3     
==========================================
- Hits         1826     1821       -5     
- Misses         82       84       +2     

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

[newville]

Thanks -- that looks great.

[newville]

Any objections to merging this?

[andrewgsavage]

we should get pre-commit running first!

[newville]

@andrewgsavage oh, right!

[newville]

@andrewgsavage Is the file at https://github.com/lmfit/uncertainties/blob/pr221/.pre-commit-config.yaml a reasonable start?
I forked your PR, added that and pushed it to a "pr221" branch here (I don't know how to push to an open PR from a user branch). You could take and add that (if it looks acceptable).

[wshanks]

Sorry, I haven't had as much time for Uncertainties recently. Ideally the pre-commit check is enforced by the CI, so it might not need to be in the list any way?

You might add some note for the PR author within <!-- --> so that it is visible while writing the PR but not in the rendered version to explain how the author should use the list -- put the PR description above/below, check things off or leave them for a reviewer?

[andrewgsavage]

Sorry, I haven't had as much time for Uncertainties recently. Ideally the pre-commit check is enforced by the CI, so it might not need to be in the list any way?

You might add some note for the PR author within <!-- --> so that it is visible while writing the PR but not in the rendered version to explain how the author should use the list -- put the PR description above/below, check things off or leave them for a reviewer?

It will need something in the github workflow too so it gets run in the checks for every PR submission.

I copied this one from pint. I've been running that pre-commit command manually because I couldnt work out how to get git bash to run pre-commit automatically on windows, so I think it is helpful to have that there. (I did work it out last week!)

It displays as a checklist so is fairly self explanatory, especially when there's other PRs using it. Most new contributors to pint check stuff off.

I opened this PR mostly so I remember to do this later!
We should get the docs merged, update changes, get a release out, then get pre-commit running in CI (I imagine there will be big diffs) first. That's the ideal order at least. I'll try to look at the docs in the next few days.