Skip to content

Commit c88e7f8

Browse files
committed
Add breaking change warning to readme
1 parent e77e7a6 commit c88e7f8

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

.gitignore

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# See https://help.github.com/ignore-files/ for more about ignoring files.
2-
31
# dependencies
42
node_modules/
53

@@ -9,22 +7,20 @@ coverage/
97
# production
108
dist/
119

12-
# misc
10+
# typescript
11+
tsc_output
12+
tsconfig*.tsbuildinfo
13+
14+
# env
1315
.DS_Store
1416
.env.local
1517
.envrc
16-
eslint_output.json
17-
tsc_output
18-
19-
npm-debug.log*
20-
yarn-debug.log*
21-
yarn-error.log*
22-
23-
# vim
24-
*.swp
2518

2619
# IDE files
2720
.idea
21+
*.swp
2822

29-
# typescript
30-
tsconfig*.tsbuildinfo
23+
# logs
24+
npm-debug.log*
25+
yarn-debug.log*
26+
yarn-error.log*

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`@sigmacomputing/plugin` has moved to https://github.com/sigmacomputing/plugin and
44
is now open source. Feel free to create an issue or contribute by opening a pull
5-
request. Read out `CONTRIBUTING.md` guide to get started.
5+
request. Read our `CONTRIBUTING.md` guide to get started.
66

77
#### Breaking Changes
88

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Plugins are built using Sigma’s Plugin API. This API communicates data and
1414
interaction events between a Sigma workbook and the plugin. Plugins are hosted
1515
by their developer and rendered in an iframe in Sigma.
1616

17+
#### Warning: Breaking Changes
18+
19+
`@sigmacomputing/plugin` has moved to https://github.com/sigmacomputing/plugin and
20+
is now open source. Please read our
21+
[CHANGELOG.md](https://github.com/sigmacomputing/plugin/blob/main/CHANGELOG.md)
22+
to review any breaking changes that have been made.
23+
1724
## Requirements
1825

1926
To test your plugin in Sigma Plugin Dev Playground, you must:

0 commit comments

Comments
 (0)