You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/04/21 14:24:54 UTC
[GitHub] [incubator-nuttx] patacongo opened a new pull request #838: Remove boilerplate from the PR template.
patacongo opened a new pull request #838:
URL: https://github.com/apache/incubator-nuttx/pull/838
So far, the use of the new pull request template has been disastrous. People are ignoring the writing instructions the template is polluting the PR history. This change just removes the boilerplate and writing instructions fromt he template. We don't need to see this unmodified serveral times per day.
# Pull Request Template
## Title guidelines
Following the guidelines for writting good commit messages (https://chris.beams.io/posts/git-commit/) and creating a meaningful title is key in effective team communication.
**do's**
- stm32h7: Add SDMMC Support
- nsh: Separate `source` and `sh` for POSIX compliance
- nxstyle: Fixed Camel case detection
- drivers/serial: Fixed style violation
**dont's**
- fixed bug
- nxstyle
- PR #12
## Description
**Describe problem solved by the PR**
A clear and concise description of the problem, if any, this PR will solve. Please also include relevant motivation and context: E.g. The current nsh sh command violates the POSIX ...
List any dependencies that are required for this change.
**Describe your solution**
A clear and concise description of what you have implemented.
**Describe possible alternatives**
A clear and concise description of alternative solutions you've considered.
**Additional context**
Add any other context or screenshots for the pr.
Fixes # (issue)
## Type of change
Delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
- [ ] Test A
- [ ] Test B
**Test Configuration**:
* Nuttx board/config:
* Hardware:
* Toolchain:
## Checklist:
- [ ] My code follows the style guidelines of this project (NEED link to how to run checkpatch)
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have checked my code and corrected any misspellings (NEED link to how to run checkpatch spelling)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
btashton commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617248795
You can also use comments to keep the commentary out of the rendered body if there a places we want to keep some of it to guide people in writing a good PR.
```
# a section heading
<!--
This is a description of what might go here. Don't worry about deleting this. l will not render in the PR.
-->
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-619627610
No one is using it so SGTM. Maybe in the future we can revisit with something less intimidating, it would be nice if some of the PRs had a little more description in them.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617238150
I think additional simplifications are also needed. Feel free to suggest changes or even to push commits to the branch on my fork. A template is good, but this is not usable in its current form.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
btashton commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617256815
It shows up in the template when you create the PR but when you submit it it goes away.
For example:
https://github.com/conan-io/conan-center-index/issues/new?labels=bug&template=package_bug.md
But yes let's keep the template minimal.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] jerpelea commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
jerpelea commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617231753
+1
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617255406
>
>
> You can also use comments to keep the commentary out of the rendered body if there a places we want to keep some of it to guide people in writing a good PR.
>
> ```
> # a section heading
> <!--
> This is a description of what might go here. Don't worry about deleting this. l will not render in the PR.
> -->
> ```
Writing instructions that people cannot see is not useful. Instructions should probably go in the Confluence workflow description.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617255498
>
>
> You can also use comments to keep the commentary out of the rendered body if there a places we want to keep some of it to guide people in writing a good PR.
>
> ```
> # a section heading
> <!--
> This is a description of what might go here. Don't worry about deleting this. l will not render in the PR.
> -->
> ```
Writing instructions that people cannot see is not useful. Instructions should probably go in the Confluence workflow description.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on pull request #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo commented on pull request #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-619629065
> No one is using it so SGTM. Maybe in the future we can revisit with something less intimidating, it would be nice if some of the PRs had a little more description in them.
We are looking for a short, to-the-point template that won't intimidate people and will encourage them to provide the information that they have. We just updated this again so now we are adopting the very sweet and short template used by Sony. I think this will help us a lot. Contributors won't be so offending and should feel comfortable in giving us the information that they have. That is all we should expect.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on issue #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo commented on issue #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-617777092
Closed due to lack of interest.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo edited a comment on pull request #838: Remove boilerplate from the PR template.
Posted by GitBox <gi...@apache.org>.
patacongo edited a comment on pull request #838:
URL: https://github.com/apache/incubator-nuttx/pull/838#issuecomment-619629065
> No one is using it so SGTM. Maybe in the future we can revisit with something less intimidating, it would be nice if some of the PRs had a little more description in them.
We are looking for a short, to-the-point template that won't intimidate people and will encourage them to provide the information that they have. We just updated this again so now we are adopting the very sweet and short template used by Sony. I think this will help us a lot. Contributors won't be so offended and should feel comfortable in giving us the information that they have. That is all we should expect.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org