Skip to content

Commit 9889bba

Browse files
committed
chore: add incomplete contributing.md
1 parent b625202 commit 9889bba

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to VSCode CSSVar extension
2+
[Draft]
3+
4+
Thanks for your support and taking time to contribute! 🎉👍
5+
6+
## Prerequisites
7+
8+
## Release/Deployments
9+
10+
Currently Deployments are managed manually by @phoenisx. I might make this more public in future, for now
11+
keeping it manual was the most easiest way for me.
12+
13+
### Releasing a new version
14+
15+
It's a two step process (and has a lot of room for improvement)
16+
17+
I maintain two custom scripts:
18+
19+
**`src/scripts/create-changelog.js`**
20+
This is required to automate creating changelog once all the changes are merged to `main` and are about to be released.
21+
This script assumes that we already have previous release version tag present in git history where the command is run.
22+
23+
We can run the following:
24+
```sh
25+
node src/scripts/create-changelog.js v2.6.4..HEAD | pbcopy
26+
```
27+
to generate changelog between previous release and latest commit.
28+
If the generated content is copied to clipboard we can use that content to modify our `CHANGELOG.md`.
29+
30+
Once we are satisfied with the updated CHANGELOG, we can commit the changes and create a new release on Github
31+
32+
**`src/scripts/publish.js`**
33+
34+
Publishing our release to VSCode/OVSX extension marketplaces.
35+
We need the private tokens for both these marketplaces for this command to work.
36+
Running this script will than auto publish our changes to both these marketplaces.

src/scripts/create-changelog.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
/**
66
* Usage:
77
* `./src/scripts/create-changelog.js v2.1.0...v2.2.0 | pbcopy`
8+
* OR
9+
* `./src/scripts/create-changelog.js v2.1.0..HEAD | pbcopy`
810
*/
911

1012
const { spawn } = require("node:child_process");

0 commit comments

Comments
 (0)