Skip to content

Contributing Guide

Contributions are welcome! This guide will help you get started with development on the Kubeseal VSCode extension.

Development Setup

Prerequisites

  • Node.js 20+
  • npm
  • VS Code 1.80.0+
  • Git

Getting Started

  1. Fork and clone the repository:

    git clone https://github.com/ops4life/kubeseal-vscode.git
cd kubeseal-vscode

  2. Install dependencies:

    npm install

  3. Compile the extension:

    npm run compile

  4. Open in VS Code:

    code .

  5. Run the extension by pressing F5 to launch the Extension Development Host.

Development Commands

Command Description
npm run compile Compile TypeScript to JavaScript
npm run watch Watch mode for development
npm test Run tests
npm run lint Run ESLint
npm run lint:fix Auto-fix ESLint issues
npm run format Format code with Prettier
npm run format:check Check formatting without modifying
npm run package Package extension as VSIX
npm run clean Clean build artifacts

Git Workflow

Never commit directly to main

Always use feature branches and create Pull Requests.

Branch Naming

Use conventional branch names:

  • feat/feature-name -- New features
  • fix/bug-name -- Bug fixes
  • docs/description -- Documentation changes
  • refactor/description -- Code refactoring

Workflow

# Create a feature branch
git checkout -b feat/my-feature

# Make your changes and commit
git add .
git commit -m "feat: add my new feature"

# Push and create a PR
git push -u origin feat/my-feature

See Commit Conventions for commit message formatting.

Code Style

  • TypeScript with strict mode enabled
  • ESLint with @typescript-eslint/recommended rules
  • Prettier for code formatting
  • Naming convention: camelCase for imports and variables
  • Use === for equality checks
  • Use unknown instead of any for type safety
  • Use async/await with promises as fs for file operations
  • Use spawn() over exec() for shell commands (security)

Testing

Run the test suite:

npm test

When adding new features, include appropriate tests. The test runner is configured to compile TypeScript first and then execute the test suite.

Pull Request Guidelines

  1. Create a feature branch from main
  2. Make your changes with clear, conventional commit messages
  3. Ensure all tests pass (npm test)
  4. Ensure code passes linting (npm run lint)
  5. Ensure code is formatted (npm run format:check)
  6. Open a Pull Request with a clear description of changes
  7. Wait for CI checks to pass and request review

Reporting Issues