Skip to content

Commit 1dcdf30

Browse files
committed
docs(tsconfig): update readme and contributing guides
1 parent 1d37d40 commit 1dcdf30

File tree

3 files changed

+50
-19
lines changed

3 files changed

+50
-19
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,14 @@ And you should be ready to go!
9393

9494
Plugin-tools is a mono-repo consisting of multiple projects. Please refer to their contributing guides to understand how to develop each one.
9595

96-
| Package Name | Readme |
97-
| ------------- | ------------------------------------------------ |
98-
| Create Plugin | [Link](./packages/create-plugin/CONTRIBUTING.md) |
99-
| Sign Plugin | [Link](./packages/sign-plugin/CONTRIBUTING.md) |
100-
| Website | [Link](./docusaurus/website/CONTRIBUTING.md) |
96+
| Package Name | Readme |
97+
| ------------- | -------------------------------------------------------- |
98+
| Create Plugin | [Link](./packages/create-plugin/CONTRIBUTING.md) |
99+
| ESlint Plugin | [Link](./packages/eslint-plugin-plugins/CONTRIBUTING.md) |
100+
| Plugin E2E | [Link](./packages/plugin-e2e/CONTRIBUTING.md) |
101+
| Sign Plugin | [Link](./packages/sign-plugin/CONTRIBUTING.md) |
102+
| TSconfig | [Link](./packages/tsconfig/CONTRIBUTING.md) |
103+
| Website | [Link](./docusaurus/website/CONTRIBUTING.md) |
101104

102105
## Contributor License Agreement (CLA)
103106

packages/tsconfig/CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Grafana / TSconfig
2+
3+
We are always grateful to receive contributions!<br />
4+
The following guidelines help you on how to start with the codebase and how to submit your work.
5+
6+
## Installation
7+
8+
### Prerequisites
9+
10+
You need to have `npm` installed.
11+
12+
### Installing
13+
14+
```bash
15+
git clone [email protected]:grafana/plugin-tools.git
16+
cd plugin-tools
17+
npm install
18+
```
19+
20+
## Overview
21+
22+
### Folder structure
23+
24+
_Work in progress._
25+
26+
## Development
27+
28+
Please read the main [contributing guide](../../CONTRIBUTING.md) before contributing any code changes to the project.
29+
30+
### Commmands
31+
32+
This package has no build process. When making changes it's best to test it either by linking it:
33+
34+
```shell
35+
npm link -w @grafana/tsconfig
36+
```
37+
38+
Or packing it into a tarball and installing it in a test repo:
39+
40+
```shell
41+
npm pack -w @grafana/tsconfig
42+
```

packages/tsconfig/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,3 @@ or:
2929
"extends": "@grafana/tsconfig/base.json"
3030
}
3131
```
32-
33-
## Publishing
34-
35-
Publishing is handled by github actions which is triggered by a merge to master that contains a change to the version property in the `package.json` file. You can either do that manually or use the command below to version bump, commit and tag.
36-
37-
```shell
38-
npm version [<newversion> | major | minor | patch ]
39-
```
40-
41-
Also be sure to update any official packages that depend on this with fixes and version increases.
42-
43-
## Versioning
44-
45-
It's probable that _any_ change will be a breaking one, so it's best to stick to major version releases.

0 commit comments

Comments
 (0)