Skip to main content

Contributing

We welcome contributions to x-fidelity! This guide explains how to contribute to the project.

Cursor IDE Users

If you're using Cursor IDE, check out our Building with Cursor guide for specialized AI tooling including slash commands, expert subagents, and step-by-step skills that accelerate development.

Getting Started​

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Install dependencies:
yarn install
  1. Create a new branch for your feature/fix

Development Workflow​

  1. Make your changes
  2. Add/update tests
  3. Run tests:
yarn test
  1. Lint code:
yarn lint
  1. Use conventional commits:
yarn commit

Pull Request Process​

  1. Push changes to your fork
  2. Create a pull request
  3. Include:
    • Clear description
    • Motivation for changes
    • Impact assessment
    • Screenshots/examples if relevant

Code Standards​

  • Follow TypeScript best practices
  • Add JSDoc comments
  • Write unit tests
  • Update documentation
  • Use conventional commits

Documentation​

When adding features, update:

  • README.md
  • API documentation
  • Website documentation
  • Code comments

Testing​

Run the test suite:

yarn test

Run specific tests:

yarn test path/to/test

Releasing​

Releases are automated via GitHub Actions:

  1. Merge to main
  2. CI runs tests
  3. Semantic release creates tag
  4. Package published to npm

Getting Help​

  • Open an issue
  • Start a discussion
  • Join our community

See the Code of Conduct for community guidelines.