Skip to content

Commit 8b7740e

Browse files
authored
Update contributing guidelines (#1700)
1 parent ebd8e37 commit 8b7740e

File tree

5 files changed

+31
-23
lines changed

5 files changed

+31
-23
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
- name: Use Node.js
6161
uses: actions/setup-node@v4
6262
with:
63-
node-version: 20
63+
node-version: 22
6464
- run: npm install
6565
- name: lint
6666
run: npm run lint
@@ -123,7 +123,7 @@ jobs:
123123
- name: Use Node.js
124124
uses: actions/setup-node@v4
125125
with:
126-
node-version: 20
126+
node-version: 22
127127
- name: Prepare build
128128
id: set-version
129129
run: |

.github/workflows/prerelease.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
- name: Use Node.js
5656
uses: actions/setup-node@v4
5757
with:
58-
node-version: 20
58+
node-version: 22
5959
- run: npm install
6060
- name: lint
6161
run: npm run lint
@@ -118,7 +118,7 @@ jobs:
118118
- name: Use Node.js
119119
uses: actions/setup-node@v4
120120
with:
121-
node-version: 20
121+
node-version: 22
122122
- name: Prepare pre-release build
123123
id: set-version
124124
run: |

CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Contributing to the ObjectScript extension for Visual Studio Code
22

3+
## Before you start
4+
5+
The extensions in the [official extension pack](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_install) are maintained by the Developer Tools team within InterSystems. We welcome community contributions, but at times may have limited bandwidth for thorough reviews alongside our other work. Before starting work on your pull request, please be aware of the following guidelines:
6+
7+
1. Make sure at least one GitHub issue exists that your pull request will "fix". If no issue exists yet, please create it before starting your work.
8+
1. If an issue already exists but is assigned to someone else, please message them before starting your work. The other user may have work in progress.
9+
1. Feature requests require a detailed spec laid out in the issue before a linked pull request will be reviewed. The spec should be approved by at least one maintainer before starting work on it. This is needed to ensure that the feature is in line with the broader roadmap for the extensions and to avoid contributors wasting their time on something that will not be accepted.
10+
311
## Contributing a pull request
412

513
### Prerequisites
614

7-
1. [Node.js](https://nodejs.org/) 18.x
15+
1. [Node.js](https://nodejs.org/) 22
816
1. Windows, macOS, or Linux
917
1. [Visual Studio Code](https://code.visualstudio.com/)
10-
1. The following VS Code extensions:
11-
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
12-
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
13-
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
1418

1519
### Setup
1620

@@ -44,9 +48,11 @@ If you want to disable all other extensions when testing in the Extension Develo
4448

4549
### Pull requests
4650

47-
Work should be done on a unique branch -- not the master branch. Pull requests require the approval of two PMC members, as described in the [Governance document](GOVERNANCE.md). PMC review is often high level, so in addition to that, you should request a review by someone familiar with the technical details of your particular pull request.
51+
Work should be done on a unique branch -- not the master branch. Pull requests require the approval of two PMC members, as described in the [Governance document](GOVERNANCE.md). PMC review is often high level, so in addition to that, you should request a review by someone familiar with the technical details of your particular pull request.
52+
53+
Please run the command `npm run lint-fix` before committing your changes. This will apply consistent styling and ensure that your pull request passes our code quality CI workflow.
4854

49-
We do expect CI to be passing for a pull request before we will consider merging it. CI executed by pull requests will produce a `vsix` file, which can be downloaded and installed manually to test proposed functionality.
55+
We expect CI to be passing for a pull request before we will consider merging it. CI executed by pull requests will produce a `vsix` file, which can be downloaded and installed manually to test proposed functionality.
5056

5157
## Beta versions
5258

package-lock.json

Lines changed: 13 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1784,7 +1784,7 @@
17841784
"@types/istextorbinary": "2.3.1",
17851785
"@types/minimatch": "5.1.2",
17861786
"@types/mocha": "^7.0.2",
1787-
"@types/node": "20.17.6",
1787+
"@types/node": "22.13.14",
17881788
"@types/semver": "7.5.4",
17891789
"@types/vscode": "1.104.0",
17901790
"@types/ws": "8.18.0",

0 commit comments

Comments
 (0)