Developer Setup and Workflow

Embedded Device Logger welcomes contributions from the community. Please review the CONTRIBUTING guide before opening a pull request.

Important: Open pull requests against the development branch. The main branch is reserved for releases.

Source code and documentation

Repository: https://github.com/ascillato/VSCode-Logger
Architecture and docs site: https://ascillato.github.io/VSCode-Logger/index.html

Build and run from source

Clone the repository.
Install dependencies and compile:
```
npm install
npm run compile
```
Launch the Extension Development Host with F5 in VS Code and open the Embedded Logger view.

Packaging and installation

Generate a VSIX (requires @vscode/vsce):
```
make package
```
Install the generated package locally:
```
make install
```

Cleaning and rebuilding

make clean
make package
make install

Or run everything at once:

make all

Linting and formatting

Install lint dependencies and run checks:

npm install --save-dev eslint prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-config-prettier eslint-plugin-prettier
make check

Documentation

Install Python requirements and build the docs:

pip install -r docs/requirements.txt
make docs

The generated HTML lives at docs/build/html/index.html.

Continuous integration builds and publishes the site from main to gh-pages.

How to contribute

Open issues for bug reports or feature requests.
Submit pull requests with clear descriptions and tests where applicable.
Run the standard project checks locally to catch regressions early:

make check
make package
make docs

Follow the coding and security practices outlined in the CONTRIBUTING guide