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

Create ISSUE_TEMPLATE.md #35

Closed

Conversation

jhlegarreta
Copy link
Member

Create an ISSUE_TEMPLATE.md file to provide a guide when submitting issues to ITK.


### Label

[Choose the label that best fits the issue]
Copy link
Member

Choose a reason for hiding this comment

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

Give a list of labels here to choose from. These labels should match the GITHUB labels for issues.

Copy link
Member

Choose a reason for hiding this comment

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

Or at least give a URL of where to find the labels.

Copy link
Member Author

Choose a reason for hiding this comment

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

@hjmjohnson thanks for the review ! This was just a proposal; the question is whether we will effectively be using labels. The VTK folks do have some, and they do use them frequently. If for any reason it is decided that we will not be using labels (despite I'd be for proposing/using them), then adding such a section is not worthwhile.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can add the Label and Milestones section later once we have figured out what labels to use and sorted out the milestoning system.


### Label

[Choose the label that best fits the issue]
Copy link
Member

Choose a reason for hiding this comment

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

Or at least give a URL of where to find the labels.


[Choose the label that best fits the issue]

### Milestones
Copy link
Member

Choose a reason for hiding this comment

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

Give a URL of where to find the list of Milestones.

Copy link
Member Author

Choose a reason for hiding this comment

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

Same comment as for the labels.

@jhlegarreta
Copy link
Member Author

An additional comment as for checking the ITK version: we could run ctest -V -R itkVersionTest -C but looks like an overkill, and the user may not have built the tests/may have had ITK installed (i.e. not compiled). Inspecting the main CMakeLists.txt may be invalid if having ITK installed.

Any thoughts or improvements?

Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

Awesome, Jon!

@@ -0,0 +1,46 @@
[Before submitting an issue, please check that your isssue hasn't been already filed]
Copy link
Member

Choose a reason for hiding this comment

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

isssue -> issue


### Label

[Choose the label that best fits the issue]
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can add the Label and Milestones section later once we have figured out what labels to use and sorted out the milestoning system.

@jhlegarreta
Copy link
Member Author

Done. Commit 7970cf0 removes the Label and Milestone sections.

I also changed the section name Platform for Environment. If you think that Platform or any other word like Toolchain for example fits better, let me know.

I also added a note at the bottom to invite users to ask questions in discourse. If you think it requires rewording, let me know.

If you think the style of the comments should be changed (e.g. italics instead of or in addition to square brackets), let me know.

Create an `ISSUE_TEMPLATE.md` file to provide a guide when submitting issues to ITK.

Change-Id: I0828b37f5999fe1d2acb59885c0ba1dc648b5d67
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

Overall, looks great. Thanks @jhlegarreta !

We still need to merge via Gerrit / Git staging system for now given how the repository mirroring is setup.


[Any additional information, configuration or data that might be necessary to reproduce the issue.]


Copy link
Member

Choose a reason for hiding this comment

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

isses -> issues

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

@jhlegarreta
Copy link
Member Author

@thewtex Thanks !

I've submitted a topic to gerrit:
http://review.source.kitware.com/#/c/22869/

to further review/merge this. I'm closing this PR then.

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