Fix issue template - simplified version #6728

0xc0170 · 2018-04-24T11:30:24Z

Description

Cherry-picked from @sg in #6687. Plus updated to match the PR type description.

Pull request type

[X] Fix
[ ] Refactor
[ ] New target
[ ] Feature
[ ] Breaking change

Lots of issues filed didnt take the time to remove the boilerplate text and give the details needed. This format mimics the update to pull requests but inverts type and description.

Add same notes about the list of available issue types

adbridge · 2018-04-24T14:16:10Z

.github/issue_template.md

+    - What toolchain is being used?
+    - What is the SHA of Mbed OS (git log -n1 --oneline)?
+    - Steps to reproduce (Did you publish code or a test case that exhibits the problem)
+-->
 ### Description


For consistency with the PR template, Description should come first at the top ?

I think I'm actually fine as-is. Issues tend to need a lot more detail than PRs. Knowing the type of issue before the description helps frame the mindset before reading the description.

Who knows, maybe the PR template could be modified to have the type come before the description?

Open for suggestions, could also move PR type first.

I'm not really seeing an issue with the original template, or a need to align particularly. PRs and issues are different things. Maybe change some things to checkboxes for a stylistic alignment, but structually this has always seemed fine to me.

Lot of people ignore it (either remove it or provide default values). Similar what we experienced with PR template.

cmonr

👍

0xc0170 · 2018-04-25T08:50:15Z

I would like to have this resolved asap to start using simplified template in the issues.

@AnotherButler Please review

0xc0170 · 2018-04-27T08:22:06Z

/morph build

mbed-ci · 2018-04-27T08:57:32Z

Build : SUCCESS

Build number : 1871
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6728/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-04-27T13:34:03Z

Exporter Build : SUCCESS

Build number : 1518
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6728/

mbed-ci · 2018-04-27T17:19:18Z

Test : SUCCESS

Build number : 1682
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6728/1682

adbridge · 2018-04-30T11:28:51Z

@AnotherButler Please review

Make minor copy edits for grammar.

0xc0170 · 2018-05-02T15:22:11Z

It was updated, time to review again !

geky · 2018-05-02T19:03:13Z

.github/issue_template.md

+    - What toolchain are you using?
+    - What is the SHA of Mbed OS (git log -n1 --oneline)?
+    - Steps to reproduce. (Did you publish code or a test case that exhibits the problem?)
+-->
 ### Description


Nit: I would put description at the top, otherwise most people just delete the whole thing thinking it's just going to get in the way.

A lot of tools, like the auto-pr-thingy, just concatenate the description smack dab on top of the template.

0xc0170 · 2018-05-03T10:48:18Z

@geky @adbridge Updated based on the feedback, now it equal to PR template as well

adbridge

Minor tweak suggested

adbridge · 2018-05-03T10:53:17Z

.github/issue_template.md

+    Good example: https://os.mbed.com/docs/latest/reference/workflow.html
+    Things to consider sharing:
+    - What target does this relate to?
+    - What toolchain are you using?


Maybe tweak to say:

What tools and their versions are being used?

Which compiler and version?

Updated via a new commit

adbridge

LGTM

0xc0170 · 2018-05-03T11:01:48Z

/morph build

mbed-ci · 2018-05-03T11:30:00Z

Build : SUCCESS

Build number : 1900
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6728/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-05-03T15:17:27Z

Exporter Build : SUCCESS

Build number : 1547
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6728/

mbed-ci · 2018-05-03T19:55:54Z

Test : SUCCESS

Build number : 1718
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6728/1718

0xc0170 added the needs: review label Apr 24, 2018

0xc0170 requested review from cmonr, theotherjimmy, kjbracey and adbridge April 24, 2018 11:30

0xc0170 force-pushed the fix-issue-template branch from 6a2d661 to a7903a8 Compare April 24, 2018 11:32

sg- and others added 2 commits April 24, 2018 12:32

Update the issue template to reduce clutter

27f2789

Lots of issues filed didnt take the time to remove the boilerplate text and give the details needed. This format mimics the update to pull requests but inverts type and description.

Issue template: match with PR template

7c9aa63

Add same notes about the list of available issue types

0xc0170 force-pushed the fix-issue-template branch from a7903a8 to 7c9aa63 Compare April 24, 2018 11:32

0xc0170 mentioned this pull request Apr 24, 2018

Update the issue template to reduce clutter #6687

Closed

5 tasks

adbridge requested changes Apr 24, 2018

View reviewed changes

cmonr previously approved these changes Apr 24, 2018

View reviewed changes

0xc0170 requested a review from AnotherButler April 25, 2018 08:50

0xc0170 changed the title ~~Fix issue template~~ Fix issue template - simplified version Apr 25, 2018

adbridge previously approved these changes Apr 26, 2018

View reviewed changes

Copy edit issue_template.md

e7a082f

Make minor copy edits for grammar.

AnotherButler dismissed stale reviews from adbridge and cmonr via e7a082f April 30, 2018 18:47

geky reviewed May 2, 2018

View reviewed changes

issue template: fix order (same as in PR template)

90c4e23

adbridge requested changes May 3, 2018

View reviewed changes

issue template: add tools version + name request

9747f19

adbridge approved these changes May 3, 2018

View reviewed changes

0xc0170 added needs: CI and removed needs: review labels May 3, 2018

0xc0170 added ready for merge and removed needs: CI labels May 7, 2018

cmonr approved these changes May 7, 2018

View reviewed changes

cmonr added the release-version: 5.8.5 label May 7, 2018

cmonr merged commit 6ab4091 into ARMmbed:master May 7, 2018

cmonr removed the ready for merge label May 7, 2018

Fix issue template - simplified version #6728

Fix issue template - simplified version #6728

Uh oh!

Conversation

0xc0170 commented Apr 24, 2018

Description

Pull request type

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cmonr left a comment

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented Apr 25, 2018

Uh oh!

0xc0170 commented Apr 27, 2018

Uh oh!

mbed-ci commented Apr 27, 2018

Triggering tests

Uh oh!

mbed-ci commented Apr 27, 2018

Uh oh!

mbed-ci commented Apr 27, 2018

Uh oh!

adbridge commented Apr 30, 2018

Uh oh!

0xc0170 commented May 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented May 3, 2018

Uh oh!

adbridge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adbridge left a comment

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented May 3, 2018

Uh oh!

mbed-ci commented May 3, 2018

Triggering tests

Uh oh!

mbed-ci commented May 3, 2018

Uh oh!

mbed-ci commented May 3, 2018

Uh oh!

Uh oh!