-
Notifications
You must be signed in to change notification settings - Fork 3k
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
github issue and PR templates #2583
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
Note: This is just a template, so feel free to use/remove the unnecessary things | ||
|
||
### Description | ||
- Type: Bug | Enhancement | Question | ||
- Related Issue: `#abc` | ||
- Priority: Blocker | Major | Minor | ||
|
||
--------------------------------------------------------------- | ||
## Bug | ||
|
||
**target** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Target |
||
K64F|?? | ||
|
||
**toolchain:** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Toolchain |
||
gcc|armcc|IAR | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpick: can we change this line to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sure, I can change this also. |
||
|
||
**toolchain version:** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Toolchain version |
||
|
||
**mbed-cli version:** | ||
(`mbed --version`) | ||
|
||
**meed-os sha:** | ||
(`git log -n1 --oneline`) | ||
|
||
**Daplink version:** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. DAPLink |
||
|
||
**Expected Behavior** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Expected behavior |
||
|
||
**Actual Behavior** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actual behavior |
||
|
||
**Steps to Reproduce** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Steps to reproduce |
||
|
||
---------------------------------------------------------------- | ||
## Enhancement | ||
|
||
**Reason to enhance/problem with existing solution** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reason to enhance or problem with... |
||
|
||
**Suggested enhancement** | ||
|
||
**Pros** | ||
|
||
**Cons** | ||
|
||
----------------------------------------------------------------- | ||
|
||
## Question | ||
|
||
**How to?** |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
Notes: | ||
* Pull requests will not be accepted until the submitter has agreed to the contributer agreement. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. link to the agreement? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. that would be usefull, I'll add it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
* This is just a template, so feel free to use/remove the unnecessary things | ||
|
||
|
||
## Status | ||
**READY/IN DEVELOPMENT/HOLD** | ||
|
||
|
||
## Migrations | ||
If this PR changes any APIs or behaviors, give a short description of what "API users" should do when this PR is merged. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why "API users"? Is it a nickname? If you just mean to draw attention to this, then use * or ** |
||
|
||
YES | NO | ||
|
||
|
||
## Description | ||
A few sentences describing the overall goals of the pull request's commits. | ||
|
||
|
||
## Related PRs | ||
List related PRs against other branches: | ||
|
||
branch | PR | ||
------ | ------ | ||
other_pr_production | [link]() | ||
other_pr_master | [link]() | ||
|
||
|
||
## Todos | ||
- [ ] Tests | ||
- [ ] Documentation | ||
|
||
|
||
## Deploy Notes | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Deployment notes |
||
Notes regarding the deployment of the contained body of work. These should note any | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm sorry but "contained body of work" is so Museum of Modern Arts There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. any good replacement suggestion ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. any good replacement suggestion ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Well, what's the difference between contained body of work and PR? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. its same thing.. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Then why not call it that? |
||
required changes in the build environment, tools, compilers, etc. | ||
|
||
|
||
## Steps to Test or Reproduce | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Steps to test or reproduce |
||
Outline the steps to test or reproduce the PR here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related issue