Skip to main content
Thank you for your interest in contributing to LiteClient! This guide covers everything you need to know to contribute effectively.

​
Getting Started

​
Prerequisites

Before you begin, ensure you have:
  • Node.js 18+
  • VS Code (for development)
  • Git

​
Setup

1

Fork the repository

Create your own fork of the LiteClient repository on GitHub.
2

Clone your fork

git clone https://github.com/liteclienthq/liteclient.git
3

Install dependencies

npm install
4

Launch development environment

Open the project in VS Code and press F5 to launch the Extension Development Host.

​
Development Workflow

​
Branch Naming

Create a branch from main using these prefixes:
PrefixPurposeExample
feature/New featuresfeature/oauth-support
fix/Bug fixesfix/response-scroll-issue
docs/Documentationdocs/update-readme
refactor/Code refactoringrefactor/extract-commands
chore/Maintenancechore/update-dependencies

​
Making Changes

1

Create your branch

git checkout -b feature/your-feature
2

Make changes incrementally

Work on your feature or fix in small, logical commits.
3

Test manually

Use the Extension Development Host (F5) to test your changes.
4

Run checks

npm run check
Ensure all type checks pass before committing.
5

Commit with clear messages

Follow the conventional commit format (see below).

​
Before Submitting

Make sure to complete this checklist before submitting your pull request:
  • Run npm run check (must pass with no errors)
  • Test the feature manually
  • Update documentation if needed

​
Commit Messages

Use conventional commit messages: 
<type>: <description>

Types:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- refactor: Code refactoring (no behavior change)
- chore: Maintenance tasks
- test: Adding or updating tests

​
Examples

feat: add OAuth 2.0 authentication support
fix: resolve scroll position reset in response panel
docs: update README with new features
refactor: extract command handlers to separate files
chore: update dependencies

​
Pull Request Process

1

Push your branch

Push your branch to your fork on GitHub.
2

Open a Pull Request

Create a PR against the main branch.
3

Ensure CI passes

Wait for all CI checks to pass.
4

Describe your changes

Provide a clear description of what your PR does and why.
5

Link related issues

Reference any related issues in your PR description.

​
Code Style

  • Strict mode enabled
  • Avoid any — use proper types or unknown
  • Shared types in src/shared/
  • Prefix with lc-
  • Extend LcBaseElement
  • Use @customElement decorator
TypeConventionExample
FilescamelCasecollectionService.ts
ClassesPascalCaseCollectionService
Functions/variablescamelCasegetCollection()
Commandsliteclient.verbNounliteclient.sendRequest
  • No comments unless complex logic requires explanation
  • Follow existing patterns in neighboring code
  • Prefer VS Code native UI over custom dialogs

​
Testing

​
Manual Testing

Press F5 in VS Code to launch the Extension Development Host where you can test your changes in a live environment.

​
Automated Testing

npm test          # Run all tests
npm run check     # TypeScript type checking
npm run lint      # ESLint validation

​
Questions?

  • Open an issue for bugs or feature requests
  • Check existing issues before creating new ones
  • See AGENTS.md for AI coding conventions

​
License

By contributing, you agree that your contributions will be licensed under the MIT License.