Skip to content

Commit 501ca01

Browse files
committed
Update contributing guidelines
1 parent b314b07 commit 501ca01

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,23 @@ need to restart your local Grafana server after every change, just
1111
refreshing the page will be sufficient.
1212

1313
## General
14-
1. Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help`
14+
- Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help`
1515

1616
## Development
17-
1. Install packages: `npx yarn install`
18-
2. Bundle plugin in dev mode: `npx yarn dev`
19-
3. Bundle plugin in dev mode and start a watcher: `npx yarn watch`
20-
4. Run the tests before submitting a PR: `npx yarn test`
21-
5. Run specific tests: `npx yarn test --testNamePattern "when some fields"`
17+
- Install packages: `npx yarn install`
18+
- Bundle plugin in dev mode: `npx yarn dev`
19+
- Bundle plugin in dev mode and start a watcher: `npx yarn watch`
20+
- Upgrade dependencies: `npx yarn upgrade`
21+
22+
### Before submitting a pull request
23+
- Run all tests: `npx yarn test`
24+
- Run specific tests: `npx yarn test --testNamePattern "when some fields"`
2225

23-
## Releasing the Grafana Map Panel
26+
## Release
2427
1. Install packages: `npx yarn install`
2528
2. Run prettier: `npx grafana-toolkit plugin:dev`
26-
3. Build into `dist/`, lint and run tests: `npx yarn build`
27-
4. Build plugin on CI: `npx grafana-toolkit plugin:ci-build`
28-
5. Create a zip package: `npx grafana-toolkit plugin:ci-package`
29+
3. Update `CHANGELOG.md` and bump version within `package.json`
30+
4. Build into `dist/`, lint and run tests: `npx yarn build`
31+
5. Build plugin on CI: `npx grafana-toolkit plugin:ci-build`
32+
6. Create a zip package: `npx grafana-toolkit plugin:ci-package`
2933
When this process succeeds, packages can be found within the `ci/packages/` folder.

0 commit comments

Comments
 (0)