Contributing

Contributions are welcome! If you’d like to improve Workspace Tasks, here’s how to get involved.

Table of Contents

  1. How to Contribute
  2. Development Setup
  3. Guidelines
  4. Project Structure
  5. Running Tests
  6. Release Supply-Chain Artifacts
  7. Contributors
  8. License
  9. Code of Conduct

How to Contribute

  • Report Issues — Found a bug or have a feature request? Open an issue on GitHub
  • Submit Pull Requests — Fork the repository, make your changes, and submit a PR
  • Improve Documentation — Help make the docs clearer or add examples
  • Share Feedback — Let us know how you use the extension and what could be better

Development Setup

  1. Fork the repository: gh repo fork camalot/vscode-workspace-tasks
  2. Open in Visual Studio Code: code vscode-workspace-tasks
  3. Reopen in Dev Container: When prompted, reopen the project in the recommended dev container for a consistent development environment
  4. Install dependencies: npm install
  5. Run the extension: Press F5 to launch a new Extension Development Host instance with the extension loaded
  6. Run tests: pnpm test to run unit tests and pnpm run test:coverage for coverage reports

Guidelines

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages using Conventional Commits
  • Add tests for new features when applicable — new code should have 100% coverage
  • Update documentation for any user-facing changes
  • Ensure all tests pass before submitting: pnpm test

Project Structure 

docs/                  ← Documentation (this site)
├── _includes/         ← Reusable markdown snippets
├── _plugins/          ← Jekyll plugins for custom functionality
├── _sass/             ← Stylesheets for custom styling
├── configuration/     ← Configuration settings documentation
├── contributing/      ← Contributing guidelines
├── features/          ← Feature documentation
├── getting-started/   ← Getting started guides
├── performance/       ← Performance optimization guides
├── task-types/        ← Task types documentation
└── troubleshooting/   ← Troubleshooting guides

src/                   ← TypeScript source code
├── commands/          ← Command implementations
├── common/            ← Shared base classes
├── libs/              ← Utility libraries
├── providers/         ← Task providers for each task type
├── services/          ← Shared services (caching, configuration, etc.)
└── test/              ← Test files

res/                   ← Resources
├── assets/images/     ← Screenshots and UI images
├── icons/             ← Task type icons (light & dark)
├── schemas/           ← JSON schemas
├── syntaxes/          ← Language grammars
└── webviews/          ← HTML webviews

docs/                  ← Documentation (this site)
sample/                ← Sample workspace for testing

Running Tests 

# Run all tests
pnpm test

# Run tests with coverage
pnpm run vscode:test:coverage

Test reports are generated to:

  • coverage/lcov.info — Coverage data
  • coverage/junit.xml — JUnit test results

Keep Mocha on version 11 while using mocha-junit-reporter 2.x. Mocha 12 changes the base reporter to an ES class, which causes the JUnit reporter to fail with TypeError: Class constructor Base cannot be invoked without 'new'. After changing test dependencies, run pnpm install and commit the updated pnpm-lock.yaml so the test runner and reporters resolve compatible Mocha versions.

The goal is 90% code coverage for existing files. New code should achieve 100% coverage.

Tests must pass on Windows as well as Unix-like systems. Derive filesystem expectations from Uri.fsPath or path utilities rather than assuming / separators, and account for platform-specific executable extensions. Mock filesystem keys must use the same native paths as the code under test. CLI tests must not depend on optional shells such as sh. Fix failing tests before submitting; do not skip tests or weaken assertions to hide failures.

Release Supply-Chain Artifacts

The release workflow generates an SPDX JSON SBOM by scanning the extracted VSIX contents. It is attached to the GitHub Release alongside the VSIX, with .sbom.json appended to the complete package filename, for example:

darthminos-workspace-tasks-1.14.4.vsix
darthminos-workspace-tasks-1.14.4.vsix.sbom.json

Before creating the release, the workflow generates GitHub build provenance attestations covering both files. The signed attestation bundle is attached to the workflow run as a versioned .vsix.provenance artifact, and the attestation is linked from the run summary. Provenance identifies the source commit checked out by the workflow; the later release commit updates release metadata. SBOM generation, attestation, and artifact upload must succeed before publishing. These artifacts are generated even when marketplace publishing is disabled.

To verify a downloaded VSIX using GitHub CLI:

gh attestation verify darthminos-workspace-tasks-1.14.4.vsix --repo camalot/vscode-workspace-tasks

Contributors

Contributors

Made with contrib.rocks.

License

This project is licensed under the Apache 2.0 License.

Code of Conduct

Please read the Code of Conduct before contributing.

Table of contents