Skip to content

PR template addition #411

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 16, 2018
Merged

PR template addition #411

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c52507
workflow: pr template addition
0xc0170 Feb 14, 2018
b7b86a7
Copy edit workflow.md
Feb 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/reference/contributing/guidelines/workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,30 @@ Pull requests on GitHub have to meet the following requirements to keep the code
- Prefixing your commit message with a domain is acceptable, and we recommend doing so when it makes sense. However, prefixing one's domain with the name of the repo is not useful. For example, making a commit entitled "mbed-drivers: Fix doppelwidget frobulation" to the `mbed-drivers` repo is not acceptable because it is already understood that the commit applies to `mbed-drivers`. Renaming the commit to "doppelwidget: Fix frobulation" would be better, if we presume that "doppelwidget" is a meaningful domain for changes, because it communicates that the change applies to the doppelwidget area of `mbed-drivers`.
- All new features and enhancements require documentation, tests and user guides for us to accept them. Please link each pull request to all relevant documentation and testing pull requests.

##### Pull request template

A good example how a pull request template should look like.

```
Fix deep sleep locking bug

# Description

Fix problems which could leave deep sleep locked unintentionally, along with adding tests to verify this behavior is fixed.

Tested locally with two targets, all toolchains.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would recommend we be specific here, to encourage others to be specific as well.

Replace "two targets" with something like "K64F and K66F".


Test results can be seen [here](just an example).

# Pull request type

- [x] Fix
Copy link
Contributor

Choose a reason for hiding this comment

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

Like the checklist.

- [ ] Refactor
- [ ] New Target
- [ ] Feature

```

#### Mbed OS maintainers

The maintainers are a small group of Mbed OS engineers who are responsible for the Mbed OS codebase. Their primary role is to progress contributions, both internal and external, from the initial pull request state through to released code. They:
Expand Down