ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
30,520 Commits
52 Branches
336 Tags
624 MiB
Commit Graph

33 Commits (a78554ebfac88da6d4f621c32ad5c0c29ff9b45f)

Author SHA1 Message Date
adbridge fa02380b22 Remove unecessary text and reinstate sub headings 2019-11-22 12:10:21 +00:00
adbridge ba0bca9462 Remove release notes section 
Feedback has shown that having similar fields in the release notes
section to the main headings is confusing. This PR simplifies the
sections and removes the release notes section completely.

Changes will be required to the release scripts and the docs to
reflect these changes.
 2019-11-22 11:29:09 +00:00
adbridge 3f2fd47a06 Simplify headers and instructions 
There is confusion with having sub headings below Description.
This commit removes teh Description header completely and promotes
sub headings to full headings.

Some of the notes under each heading have also been updated to
provide better clarity.
 2019-11-21 16:18:19 +00:00
Bartek Szatkowski dd7f557fc7
Fix an article 
An -> A for "user"
 2019-11-21 10:31:47 +00:00
Bartek Szatkowski 422e59ffb9
Some fixes to PR 
Various changes including:
Fix header levels
Fix typos
Move more text to comments
 2019-11-19 14:31:53 +00:00
Anna Bridge 7349001547
Clarify release note section requirements 2019-09-26 14:54:03 +01:00
Anna Bridge f8dc87c5ba
Add clarity to description and reword tests options 2019-09-26 11:55:51 +01:00
Anna Bridge 580af4e4d2
Improve formatting 
Made required/optional italic and removed a couple of superfluous lines
 2019-09-25 16:14:18 +01:00
Anna Bridge 1725d5bdef
Add addional guidance 2019-09-25 16:05:35 +01:00
Anna Bridge 4e505f6b52
Add test results section 
Also add section separators
 2019-09-25 15:38:53 +01:00
adbridge 2127b45953 Simplify pull request template 
Condense multiple options into the main three and summarise what
can go into those 3 types.

Add a test results section.

Add compulsory sections to Release Notes.
 2019-09-25 11:55:00 +01:00
Jeroen de Bruijn b47a2ad346
docs: fix release notes link in PR template 2019-02-26 14:57:42 +01:00
Oren Cohen 37629909f5 Add release notes section to PR template 2019-02-14 13:38:11 +02:00
Volodymyr Medvid af56cd8b87 Fix links to documentation on https://os.mbed.com 2019-01-21 14:56:40 -08:00
Amanda Butler 0a53b02ee4
Make minor change in pull_request_template.md 
Fix nit for precise language
 2018-12-19 10:46:59 -06:00
Martin Kojtal cd54ed9cd5 github: add reviewers to the PR template 
Use @mention to request specific reviewers.
 2018-12-19 09:34:43 +00:00
Martin Kojtal a88ed6eff1 PR template: add "test update" 
Adding new test case, test unit or just updating tests
 2018-09-25 14:11:39 +01:00
Martin Kojtal aac58a7e21 PR template: add "docs update" 
As we know have documentation in the repository, this type should define changes
only to documentation.
 2018-09-25 09:30:58 +01:00
Martin Kojtal 49a91dbd01 PR template: Feature -> functionality change 
Feature might be misinterpreted in some cases. This label should be about
functionality in backward compatible way. That means that this is either
deprecating some current one or adding new functionality.

Functionality change should cover:
- adding configuration
- deprecating functionality
- adding new functionality

This change would go automatically to feature release.
 2018-08-08 12:50:12 +01:00
Martin Kojtal 61f12b48ad PR template: fix target update list 
Not only new target, any target update goes to own section. This covers
target updates to SDK, HAL implementation, target list, etc.
All these go to patch releases.
 2018-08-03 09:57:00 +01:00
Sam Grove 8aec9e6638 Update URL that points at a blank page. 
Looks like the URL changed where #workflow became workflow.html
 2018-04-24 12:19:40 +01:00
Wilfried Chauveau 345bc493f5 make PR type box list "fancier" without making it a github tasklist 2018-04-18 15:18:10 +01:00
Martin Kojtal 66821da494 PR template: fix tick definition 
Use X to fill PR template and be more specific about only one PR type per pull request.
 2018-04-12 13:36:21 +01:00
Martin Kojtal e2d0eaf1cc PR template: do not use task list 2018-03-21 11:56:38 +00:00
Martin Kojtal ecc9edaa4f PR template: only one should be checked 2018-03-20 11:54:25 +00:00
Martin Kojtal aeef061d47 PR template: fix task 2018-03-20 11:54:25 +00:00
Martin Kojtal 668f4d316a pull request: add required info 
Please use these 2 sections for describing a pull request. They should be part
of every pull request.

The type specifies what is expected from the pull request and when it can be
released. For instance a feature pull request can't be expected to go to the
patch release.

Important: do not mix pull request types !

Changed also the heading type, to make it smaller.
 2018-02-27 16:06:20 +00:00
Martin Kojtal 775a1fb4b0 Pull request template update 
New version of the PR template.

Ideal PR should contain:

- detailed description of changes
- how it was tested
- dependencies
- PR type (one of)
 2018-02-20 16:02:36 +00:00
Amanda Butler 089f42dee4
Copy edit pull_request_template.md 
Make minor copy edit to match our style guide to fulfill older JIRA task.
 2017-10-27 13:41:02 -05:00
Jussi Vatjus-Anttila 709ef59875 Update pull_request_template.md 2016-09-08 12:05:47 +03:00
Jussi Vatjus-Anttila 018f205a27 Update pull_request_template.md 2016-09-02 15:27:10 +03:00
Jussi Vatjus-Anttila 217b0da044 small updates 2016-08-31 15:08:51 +03:00
Jussi Vatjus-Anttila 691555aa22 initial github issue and PR templates 2016-08-30 11:06:18 +03:00