Skip to content

Commit 53375a3

Browse files
committed
Update contributing guidelines
1 parent 75c34ed commit 53375a3

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,22 @@ refreshing the page will be sufficient.
1818
- Bundle plugin in dev mode: `npx yarn dev`
1919
- Bundle plugin in dev mode and start a watcher: `npx yarn watch`
2020
- Upgrade dependencies: `npx yarn upgrade`
21-
22-
### Before submitting a pull request
2321
- Run all tests: `npx yarn test`
2422
- Run specific tests: `npx yarn test --testNamePattern "when some fields"`
2523

24+
## Before submitting a pull request
25+
- Make sure your improvement gets accompanied by a corresponding test case
26+
- Run linter/prettier: `npx grafana-toolkit plugin:dev`
27+
2628
## Release
2729
1. Install packages: `npx yarn install`
28-
2. Run prettier: `npx grafana-toolkit plugin:dev`
29-
3. Update `CHANGELOG.md` and bump version within `package.json`
30-
4. Commit changes
31-
5. Tag repository: `git tag 0.xx.0`
32-
6. Push repository: `git push && git push --tags`
33-
7. Build plugin:
30+
2. Bump version within `package.json` and update `CHANGELOG.md`
31+
3. Commit changes
32+
4. Tag repository: `git tag 0.xx.0`
33+
5. Push repository: `git push && git push --tags`
34+
6. Build plugin:
3435
- `npx grafana-toolkit plugin:ci-build`
3536
- `npx grafana-toolkit plugin:ci-build --finish`
36-
8. Create zip package: `npx grafana-toolkit plugin:ci-package`
37+
7. Create zip package: `npx grafana-toolkit plugin:ci-package`
3738
When this process succeeds, packages can be found within the `ci/packages/` folder.
38-
The `Error signing manifest` warning can be ignored, YMMV.
39+
The `Error signing manifest` warning can optionally be ignored, YMMV.

0 commit comments

Comments
 (0)