skills-vault/CONTRIBUTING.md

Contributing to Skills Vault

Thanks for your interest in contributing to Skills Vault.

This project is a CLI for backing up and restoring Agent Skills. We welcome bug reports, documentation improvements, tests, and focused feature proposals.

Before You Start

• Read the README for the project overview and command surface.
• Read the Code of Conduct before participating.
• For security issues, follow SECURITY.md instead of opening a public issue.

Ways to Contribute

• Report bugs
• Improve documentation
• Add or improve tests
• Propose targeted CLI improvements
• Fix small usability issues or polish error messages

If you plan to work on a larger change, open an issue first so we can agree on scope before implementation starts.

Development Setup

Prerequisites:

• Bun >=1.3.11

Install dependencies:

bun install

Useful commands:

bun run format
bun run test
bun run check

Contribution Workflow

1. Fork the repository and create a focused branch.
2. Make the smallest change that solves the problem well.
3. Add or update tests when behavior changes.
4. Run bun run check before opening a pull request.
5. Update documentation when user-facing behavior changes.
6. Open a pull request with a clear description of the change and why it is needed.

Pull Request Guidelines

Good pull requests are:

• Small and focused
• Clear about user impact
• Covered by tests when behavior changes
• Updated to match the current CLI behavior and docs

Please include:

• What changed
• Why it changed
• How you verified it
• Any follow-up work or known limitations

Reporting Bugs

Open a GitHub issue with:

• Your environment
• The command you ran
• Expected behavior
• Actual behavior
• Logs or screenshots when relevant
• A small reproduction, if possible

Feature Requests

Feature requests are welcome, especially when they are:

• Clearly scoped
• Tied to a concrete user problem
• Consistent with the project's CLI-first design

Style Notes

• Keep changes consistent with the existing TypeScript and CLI patterns.
• Prefer precise error messages and deterministic output.
• Avoid unrelated refactors in the same pull request.

Thanks for helping make Skills Vault easier to use and maintain.