Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

MNT: Add issue templates #560

Merged
merged 4 commits into from
Apr 26, 2021
Merged

MNT: Add issue templates #560

merged 4 commits into from
Apr 26, 2021

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Apr 22, 2021 •
edited
Loading

Add issue templates for bug reports and feature requests for each viz. There is a bit of duplication but it is necessary to apply different labels.

@pllim pllim marked this pull request as draft April 22, 2021 19:40
@pllim pllim changed the title MNT: Add bug template for Specviz MNT: Add issue templates Apr 22, 2021
@pllim pllim marked this pull request as ready for review April 22, 2021 20:09
@pllim pllim added the 💤 enhancement New feature or request label Apr 22, 2021
ibusko
ibusko reviewed Apr 23, 2021
View reviewed changes
Copy link
Contributor

@ibusko ibusko left a comment

Choose a reason for hiding this comment

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

Maybe the bug report templates should have an explicit reminder to reference data files, whenever the bug seems to be data-driven. The "Additional context" section perhaps should mention something like "Additional context (e.g. data files)".

@pllim
Copy link
Contributor Author

pllim commented Apr 23, 2021

@ibusko , can you please provide me with the changes you have in mind as code suggestion in one of the bug template? I can then propagate it into the other ones. Thanks!

@ibusko
Copy link
Contributor

ibusko commented Apr 23, 2021

@pllim I added a sort of reminder to line 70 in the cubeviz bug report template. It's only a suggestion, because I don't know if these things can be modified at will or not. Perhaps there is software upstream that expects specific wording and such?

@pllim
Copy link
Contributor Author

pllim commented Apr 23, 2021

expects specific wording and such?

Naw... Only the stuff between the --- at the top means something. The rest is for humans.

@pllim
Copy link
Contributor Author

pllim commented Apr 23, 2021

Pushed a commit. What about now?

ibusko
ibusko approved these changes Apr 23, 2021
View reviewed changes
Copy link
Contributor

@ibusko ibusko left a comment

Choose a reason for hiding this comment

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

LGTM. Great addition to our setup!

@pllim
Copy link
Contributor Author

pllim commented Apr 23, 2021

For completeness, you can see the astropy issue templates in action over at https://github.com/astropy/astropy/issues/new/choose . Only you'll have 8 to choose from instead of 2.

rosteen
rosteen approved these changes Apr 23, 2021
View reviewed changes
Copy link
Collaborator

@rosteen rosteen 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!

@pllim pllim merged commit 2cf958e into main Apr 26, 2021
@pllim pllim deleted the pllim-patch-1 branch April 26, 2021 14:15
@pllim
Copy link
Contributor Author

pllim commented Apr 26, 2021

Hopefully not overkill...

Screenshot 2021-04-26 101715

@pllim
Copy link
Contributor Author

pllim commented Apr 26, 2021

Bug template in action: #569

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@rosteen rosteen rosteen approved these changes

@ibusko ibusko ibusko approved these changes

@duytnguyendtn duytnguyendtn Awaiting requested review from duytnguyendtn

@javerbukh javerbukh Awaiting requested review from javerbukh javerbukh is a code owner

Assignees
No one assigned
Labels
💤 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pllim @ibusko @rosteen