tobac-project / tobac

Tracking and object-based analysis of clouds
BSD 3-Clause "New" or "Revised" License
99 stars 53 forks source link

Adding checklists for the issue tracker #358

Closed fziegner closed 10 months ago

fziegner commented 11 months ago

This PR addresses #174 by adding templates for the issue tracker. I checked how projects like pandas and numpy manage this which mostly is in the form of interactive forms using YAML. These don't allow editing the issue while creating it so I opted to use Markdown in the style of the pull request template.

I created a repository here so you can check out how the templates look like in action. Is this what you had in mind @freemansw1? Unfortunately, Markdown doesn't support variables so you'd still have to manually replace the version number in the release template.

codecov[bot] commented 11 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (f87ea1e) 55.75% compared to head (17392d0) 56.79%. Report is 127 commits behind head on RC_v1.5.x.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## RC_v1.5.x #358 +/- ## ============================================= + Coverage 55.75% 56.79% +1.03% ============================================= Files 15 20 +5 Lines 3316 3435 +119 ============================================= + Hits 1849 1951 +102 - Misses 1467 1484 +17 ``` | [Flag](https://app.codecov.io/gh/tobac-project/tobac/pull/358/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/tobac-project/tobac/pull/358/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | `56.79% <ø> (+1.03%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

fziegner commented 10 months ago

Thanks for the reviews. I'll remove the draft status then.

freemansw1 commented 10 months ago

The notebook CI is failing, but it was also doing so before this PR. I've opened a new issue for that (#370). @fziegner are you happy for us to go ahead and merge this?

w-k-jones commented 10 months ago

I'm happy to merge as well, as the Jupyter CI issue has nothing to do with this PR

fziegner commented 10 months ago

Yes @freemansw1, no objections from me.