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

Fix issue template - simplified version #6728

Merged
merged 5 commits into from May 7, 2018

Conversation

Projects
None yet
8 participants
@0xc0170
Member

0xc0170 commented Apr 24, 2018

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

@0xc0170 0xc0170 force-pushed the 0xc0170:fix-issue-template branch from 6a2d661 to a7903a8 Apr 24, 2018

sg- and others added some commits Apr 19, 2018

Update the issue template to reduce clutter
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
Add same notes about the list of available issue types

@0xc0170 0xc0170 force-pushed the 0xc0170:fix-issue-template branch from a7903a8 to 7c9aa63 Apr 24, 2018

@0xc0170 0xc0170 referenced this pull request Apr 24, 2018

Closed

Update the issue template to reduce clutter #6687

1 of 5 tasks complete
- 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

This comment has been minimized.

@adbridge

adbridge Apr 24, 2018

Contributor

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

This comment has been minimized.

@cmonr

cmonr Apr 24, 2018

Contributor

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?

This comment has been minimized.

@0xc0170

0xc0170 Apr 25, 2018

Member

Open for suggestions, could also move PR type first.

This comment has been minimized.

@kjbracey-arm

kjbracey-arm Apr 25, 2018

Contributor

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.

This comment has been minimized.

@0xc0170

0xc0170 Apr 25, 2018

Member

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

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Apr 25, 2018

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

@AnotherButler Please review

@0xc0170 0xc0170 requested a review from AnotherButler Apr 25, 2018

@0xc0170 0xc0170 changed the title from Fix issue template to Fix issue template - simplified version Apr 25, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Apr 27, 2018

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Apr 27, 2018

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

This comment has been minimized.

@mbed-ci

This comment has been minimized.

@adbridge

This comment has been minimized.

Contributor

adbridge commented Apr 30, 2018

@AnotherButler Please review

Copy edit issue_template.md
Make minor copy edits for grammar.

@AnotherButler AnotherButler dismissed stale reviews from adbridge and cmonr via e7a082f Apr 30, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented May 2, 2018

It was updated, time to review again !

- 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

This comment has been minimized.

@geky

geky May 2, 2018

Member

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

This comment has been minimized.

Member

0xc0170 commented May 3, 2018

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

@adbridge

Minor tweak suggested

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?

This comment has been minimized.

@adbridge

adbridge May 3, 2018

Contributor

Maybe tweak to say:

  • What tools and their versions are being used?
  • Which compiler and version?

This comment has been minimized.

@0xc0170

0xc0170 May 3, 2018

Member

Updated via a new commit

@adbridge

LGTM

@0xc0170

This comment has been minimized.

Member

0xc0170 commented May 3, 2018

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented May 3, 2018

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

This comment has been minimized.

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

@mbed-ci

This comment has been minimized.

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

@cmonr

cmonr approved these changes May 7, 2018

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

13 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-mbed2-build build completed
Details
ci-morph-test test completed
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
travis-ci/astyle Passed, 582 warnings (+0 warnings)
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 10182 cycles (-18 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/littlefs Passed, code size is 10112B (+0.00%)
Details
travis-ci/tools Local tools testing has passed
Details

@cmonr cmonr removed the ready for merge label May 7, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment