Contributing

Contributions are welcome! This page provides information on how to set up the development environment and contribute to PageSieve.

Development Setup

  1. Clone the repository: git clone https://github.com/julius383/PageSieve.git
  2. Install dependencies: bun install
  3. Start the build process: bun run build:extension (for production)

Build Commands

  • bun run build:extension: Generates the production extension in apps/extension/dist/.
  • bun run build:cli: Generates the CLI bundle in apps/cli/dist/.
  • bun run lint: Runs ESLint to check for code quality issues across packages and apps.
  • bun run format: Formats the codebase using Prettier.

Just Tasks

If you have just installed, you can use the following commands:

  • just build-extension: Build the browser extension.
  • just build-cli: Build the CLI application.
  • just watch: Start file watcher to rebuild upon changes.
  • just lint: Lint the monorepo.
  • just format: Format the monorepo.
  • just docs-preview: Start a local Quarto documentation preview server.
  • just docs-build: Render the documentation site.

Submitting Changes

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Commit your changes and push them to your fork.
  4. Submit a pull request with a clear description of your changes.