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

Improved issue templates #1434

Merged

Conversation

CodyCBakerPhD
Copy link
Collaborator

@CodyCBakerPhD CodyCBakerPhD commented Feb 23, 2022

Motivation

GitHub is improving their support for advanced issue templates; these new ones appear and behave more like abbreviated forms, which makes it much easier for users and developers to communicate the minimal amount of information directed to their current needs. It also allows us to include tidbits of extra information (like nicer external links) to direct them in their search for answers.

You can view previews of the forms (minus the GitHub encoding header) by viewing the raw files through the web GUI: bug report, feature request, and documentation

Some examples particular to the NWBInspector and their outputs here: https://github.com/catalystneuro/nwbinspector/issues

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@rly
Copy link
Contributor

rly commented Mar 16, 2022

@CodyCBakerPhD is this ready for review?

rly
rly previously approved these changes Mar 16, 2022
Copy link
Contributor

@rly rly left a comment

Choose a reason for hiding this comment

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

Looks great! Thank you

@CodyCBakerPhD
Copy link
Collaborator Author

@rly Yep, entirely up to you if you want to make any format changes, etc. Just leaving a similar skeleton here to what is currently on the Inspector and CT

@rly rly merged commit 767711b into NeurodataWithoutBorders:dev Mar 16, 2022
@rly rly deleted the improved_issue_templates branch March 16, 2022 23:06
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.

3 participants