Skip to content

Commit 4f525f6

Browse files
authored
docs(template): add breaking change section (#5226)
* docs(template): add breaking change section * docs(template): update readme.md * docs: add contributing section for templates * docs(tempalte): rename document
1 parent 930c6d4 commit 4f525f6

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ For contributing to different packages, find the instructions below:
2121
- [Contributing to Function Extension](https://github.com/OfficeDev/TeamsFx/blob/main/packages/function-extension/CONTRIBUTING.md)
2222
- [Contributing to Simple Auth](https://github.com/OfficeDev/TeamsFx/blob/main/packages/simpleauth/CONTRIBUTING.md)
2323
- [Contributing to .NET SDK](https://github.com/OfficeDev/TeamsFx/blob/main/packages/dotnet-sdk/CONTRIBUTING.md)
24+
- [Contributing to Scaffolding Template](https://github.com/OfficeDev/TeamsFx/blob/main/templates/CONTRIBUTING.md)
2425

2526
# Code of Conduct
2627

packages/fx-core/src/common/template-utils/readme.md templates/CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,28 @@ To scaffold from alpha release templates, set `TEAMSFX_TEMPLATE_PRERELEASE=alpha
2020
```
2121
2. In cd pipeline, all templates in the list will be zipped and be released to GitHub.
2222

23+
3. If your new template can not be scaffolded by older version Teams Toolkit, you need to commit your changes with a `BREAKING CHANGE` footer. The body of the footer has to be multi-line and the footer line must start with `BREAKING CHANGE:`
24+
```
25+
$ git add .
26+
27+
$ git commit -m "feat(tab): upgrade react-scirpts
28+
BREAKING CHANGE: drop support for Node 12"
29+
30+
$ git push
31+
```
32+
33+
Some breaking change cases:
34+
35+
* Involve new placeholder in templates.
36+
* Upgrade template's dependencies which deprecates support to lower version NodeJs. Latest Teams Toolkit notices users to upgrade their environment but older version Teams Toolkit does not.
37+
* Remove or rename templates.
38+
39+
Cases that are not breaking changes:
40+
41+
* Add new templates that old Teams Toolkit does not have entry to get and scaffold them.
42+
* Add new features to templates that does not require any change in Teams Toolkit.
43+
* Totally rewrite a template but old Teams Toolkit can still work with it.
44+
2345
## How to debug templates?
2446

2547
1. Set `TEAMSFX_DEBUG_TEMPLATE=true` to your environment variables.

0 commit comments

Comments
 (0)