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.

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

Adding checklists for the issue tracker #358

Merged
merged 5 commits into from
Nov 27, 2023

Conversation

fziegner
Copy link
Collaborator

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.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@fziegner fziegner added the enhancement Addition of new features, or improved functionality of existing features label Oct 26, 2023
@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@              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 Coverage Δ
unittests 56.79% <ø> (+1.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@freemansw1 freemansw1 left a comment

Choose a reason for hiding this comment

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

Thanks for taking this on, @fziegner . This is indeed what I had in mind. I've made a small comment, but I think this is overall ready to be moved out of draft.

.github/ISSUE_TEMPLATE/bug-report.md Outdated Show resolved Hide resolved
@fsenf fsenf added this to the Version 1.5.2 milestone Nov 23, 2023
@fsenf fsenf mentioned this pull request Nov 23, 2023
8 tasks
@fziegner fziegner requested a review from w-k-jones November 23, 2023 18:38
Copy link
Member

@w-k-jones w-k-jones left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for adding this! We can always add more templates in future (e.g. a feature request template), but I think it's best to add these straight away

@fziegner
Copy link
Collaborator Author

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

@fziegner fziegner marked this pull request as ready for review November 27, 2023 13:18
@freemansw1
Copy link
Member

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
Copy link
Member

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

@fziegner
Copy link
Collaborator Author

Yes @freemansw1, no objections from me.

@freemansw1 freemansw1 merged commit 68a2d7a into tobac-project:RC_v1.5.x Nov 27, 2023
19 of 20 checks passed
@w-k-jones w-k-jones mentioned this pull request Dec 2, 2023
@fziegner fziegner deleted the checklists branch December 4, 2023 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Addition of new features, or improved functionality of existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants