CONTRIBUTING.md

Contributing

👍🎉 Thank you for taking the time to contribute! 🎉👍

In this file you will find all the steps necessary to guide you through your first contribution to the project.

Please note our Code of Conduct and adhere to it in all your interactions with this project.

📚 Getting Started

Downloading ⬇️

Firstly, fork the repository from https://github.com/fortran-lang/vscode-fortran-support.

Then clone the repository into your local machine.

git@github.com:<YOUR-USERNAME>/vscode-fortran-support.git

Where <YOUR-USERNAME> should be your GitHub username.

Dependencies

To build this project you will need NodeJS >= 20.0.0. Open a terminal and run for a quick dependency installation:

npm ci

or for a full dependency installation:

npm install

Compiling 🏗️

During development, you can run a watcher to continuously check for changes and compile the extension:

npm run watch-dev

or do a standalone compilation via:

npm run compile-dev

👉 Tip! You can press CTRL+SHIFT+B (CMD+SHIFT+B on Mac) to start the watch task.

Developing & Debugging 🐞️

You can now start writing code, the watcher task, if not running, will automatically start when debugging. You can actively debug the extension by pressing F5 with Launch Extension selected.

👉 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 VS Code window prefixed with [Extension Development Host].

Contributing.Demo.mp4