Skip to content

Commit b8ce0f7

Browse files
committed
Add CONTRIBUTING with some basic info
1 parent dbb416d commit b8ce0f7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
## Versioning policy
4+
5+
`lsp` and `lsp-types` should typically have identical versions and be released in lockstep.
6+
This is for two reasons:
7+
1. They are morally one package, and may become one again once multiple public libraries are better supported.
8+
2. `lsp` exports many types from `lsp-types`, so in practice will need a major verison bump when `lsp-types` does anyway.
9+
10+
`lsp-test` can evolve independently.
11+
12+
## Git tags
13+
14+
The tagging scheme is `$package-$version`, e.g. `lsp-types-1.0.0`.
15+
16+
## Making a release
17+
18+
1. Bump version numbers as needed (see 'Versioning policy')
19+
2. Update changelogs (currently manual, sadly)
20+
3. Once the above is in master, create git tags following 'Git tags'
21+
4. Create package candidates for the packages, and check that they all look good.
22+
5. Finalize the package candidates.

0 commit comments

Comments
 (0)