Skip to content

Commit 04d805a

Browse files
committed
Updated Contributing doc
1 parent cbe12ee commit 04d805a

File tree

1 file changed

+56
-11
lines changed

1 file changed

+56
-11
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,60 @@
1-
# #CONTRIBUTING
1+
# Contributing
22

3-
You _always_ want to look at this file **before** contributing. In here you
4-
should find steps that you need to take to set up your development environment
5-
as well as instructions for coding standards and contribution guidelines.
3+
👍🎉 Thank you for taking the time to contribute! 🎉👍
64

7-
## Setup instructions
5+
In this file you will find all the steps necessary to guide you through your first contribution to the project.
86

9-
First of all, this is a Visual Studio Code extension that uses TypeScript and tools based on [Node.js](https://nodejs.org/en/) with dependencies from npm. So you will need to have Node installed on your `$PATH`.
7+
Please note our [Code of Conduct](https://github.com/fortran-lang/.github/blob/main/CODE_OF_CONDUCT.md) and adhere to it in all your interactions with this project.
108

11-
1. Fork the repo
12-
2. Clone your fork
13-
3. Create a branch
14-
4. Run `npm install`
15-
5. To test the extension run `npm run test:grammar && npm test`
9+
## 📚 Getting Started
10+
11+
### Downloading ⬇️
12+
13+
Firstly, fork the repository from <https://github.com/fortran-lang/vscode-fortran-support>.
14+
15+
Then clone the repository into your local machine.
16+
17+
```sh
18+
[email protected]:<YOUR-USERNAME>/vscode-fortran-support.git
19+
```
20+
21+
Where `<YOUR-USERNAME>` should be your GitHub username.
22+
23+
### Dependencies
24+
25+
To build this project you will need [NodeJS](https://nodejs.org/) `>= 16.13.1`.
26+
Open a terminal and run for a quick dependency installation:
27+
28+
```sh
29+
npm ci
30+
```
31+
32+
or for a full dependency installation:
33+
34+
```sh
35+
npm install
36+
```
37+
38+
### Compiling 🏗️
39+
40+
During development, you can run a watcher to continuously check for changes and compile the extension:
41+
42+
```sh
43+
npm run watch-dev
44+
```
45+
46+
or do a standalone compilation via:
47+
48+
```sh
49+
npm run compile-dev
50+
```
51+
52+
👉 **Tip!** You can press <kbd>CTRL+SHIFT+B</kbd> (<kbd>CMD+SHIFT+B</kbd> on Mac) to start the watch task.
53+
54+
### Developing & Debugging 🐞️
55+
56+
You can now start writing code the `watcher` task will check for compilation errors.
57+
You can actively debug the extension by pressing <kbd>F5</kbd> with `Launch Extension` selected.
58+
59+
👉 **Tip!** You don't need to stop and restart the development version of VS Code after each change. You can just execute `Reload Window` from the command palette in the
60+
VS Code window prefixed with `[Extension Development Host]`.

0 commit comments

Comments
 (0)