Pull Request Guide

How to submit changes to SilentSuite.

Before You Start

1. Check for existing issues. If there's an issue for what you want to work on, comment on it to let others know you're picking it up.
2. Open an issue first for large changes. If you're proposing a new feature or significant refactor, open an issue to discuss the approach before writing code.

Workflow

1. Fork and Clone

git clone https://github.com/YOUR-USERNAME/silentsuite.git
cd silentsuite
pnpm install

2. Create a Branch

Create a branch from main with a descriptive name:

git checkout -b fix/login-timeout
git checkout -b feature/task-export

3. Make Your Changes

• Follow the Code Conventions.
• Write or update tests for your changes (see Testing).
• Update documentation if your change affects user-facing behaviour.

4. Verify

Run all checks locally before pushing:

pnpm lint
pnpm type-check
pnpm test
pnpm build

5. Push and Open a PR

git push origin your-branch-name

Open a pull request on GitHub against the dev branch.

PR Description

Include in your PR description:

• What the change does.
• Why the change is needed (link the issue if there is one).
• How to test it.

You can also copy this short template and fill it in:

## What changed?
- Added/changed/fixed ...

## How I checked it
- Docs-only change / ran ... / not run because ...

For docs-only PRs, it is okay to write Docs-only change; no app tests run. If you previewed the docs locally, mention that too.

Review Process

• A maintainer will review your PR and may request changes.
• Address review feedback by pushing additional commits to your branch.
• Once approved, a maintainer will merge your PR.

Tips

• Keep PRs small and focused. One change per PR is easier to review.
• If your PR includes documentation updates, even better.
• Don't be discouraged by review feedback -- it's part of the process.