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

DDF-04286 First pass at trying to improve the issue template #4289

Merged
merged 4 commits into from
Jan 31, 2019

Conversation

Kjames5269
Copy link
Contributor

What does this PR do?

Gets the conversation started on fixing the issue template. There are issues that aren't just bugs that also need to be addressed and handled gracefully by the template without making it into a cluttered mess.

I'd love to hear thoughts on the suggestion. This only addresses issues that are categorized into improvements, documentation and bugs.

The hardest issue to handle is documentation since that needs the least information about it, only a description and version, but for improvements and bug issues you can discuss what the expected behavior is after the change is implemented, and bugs issues just need the rest of the information.

Who is reviewing it?

@coyotesqrl @ricklarsen @rymach @vinamartin

Select relevant component teams:

@codice/website ?

Ask 2 committers to review/merge the PR and tag them here.

How should this be tested?

Consider different issues that may arise and see if they are gracefully handled by the template

Any background context you want to provide?

What are the relevant tickets?

For Jira:

For GH Issues:
Fixes: #4286

Screenshots

Checklist:

  • Documentation Updated
  • Update / Add Threat Dragon models
  • Update / Add Unit Tests
  • Update / Add Integration Tests

Notes on Review Process

Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.

Review Comment Legend:

  • ✏️ (Pencil) This comment is a nitpick or style suggestion, no action required for approval. This comment should provide a suggestion either as an in line code snippet or a gist.
  • ❓ (Question Mark) This comment is to gain a clearer understanding of design or code choices, clarification is required but action may not be necessary for approval.
  • ❗ (Exclamation Mark) This comment is critical and requires clarification or action before approval.

@@ -13,20 +13,25 @@ is the best place for getting support.

[Description of the issue]

### Steps to Reproduce (if issue is bug)
#### Expected behavior (if applicable):
Copy link
Member

Choose a reason for hiding this comment

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

I like this change because it implies that Improvements should have an expected behavior (and they should!)

.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE.md Show resolved Hide resolved
@Kjames5269
Copy link
Contributor Author

I updated the PR to use the newer issue reporting. There are two options which are bug fixes and improvements because those both cover all fields. One cool thing about it is that with this you can auto assign labels. So right now bug tickets are assigned as such automatically, (or they should be)

Copy link
Member

@coyotesqrl coyotesqrl left a comment

Choose a reason for hiding this comment

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

I'd like us to get this merged this morning so we can get the new templates into rotation and see if they start to improve the process.

#### Actual behavior:
<!-- What actually happens -->

#### Reproduces how often:
Copy link
Member

Choose a reason for hiding this comment

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

✏️ I'm not sure if it needs its own section, but can we add something about potential workarounds?
Maybe that's best suited for the Description block.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point 👍 I'm looking at the description within the bug template and it could go there. I don't think we need to have why is this change being proposed when it's a bug

@@ -0,0 +1,36 @@
---
name: Improvement
Copy link
Member

Choose a reason for hiding this comment

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

❓ Are "New Feature" and "Improvement" the same thing? Should they have different templates?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if the templates would differ aside from auto assigning tags and maybe some of the comments within the description. How do you think the templates would differ?

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure that they would I was posing it more so as a question. This works for now 👍

Copy link
Member

Choose a reason for hiding this comment

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

They're definitely different but I'm not sure (yet) whether they have different content needs or that we would automate labeling and/or assigning them much differently.

@coyotesqrl
Copy link
Member

CI skipped for repo metafiles.

@coyotesqrl coyotesqrl merged commit 576e072 into codice:master Jan 31, 2019
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.

Issue Template improvements
4 participants