Contributing

Thank you for your interest in contributing to the JigsawStack Translation Widget. This page walks you through the full contribution workflow.

Contributing Workflow

Fork the repository

Click the Fork button at the top right of the repository page on GitHub to create your own copy.

Clone your fork

git clone https://github.com/your-username/translation-widget.git
cd translation-widget

Create a feature branch

Use a descriptive branch name:

git checkout -b feature/your-feature-name

Set up your environment

Install dependencies:

yarn install

Create a .env file in the project root with your JigsawStack public API key:

VITE_TRANSLATION_WIDGET_PUBLIC_KEY=your_api_key_here

Build the project (required before running the dev server):

yarn build

Start the development server:

yarn dev

Open your browser and visit http://localhost:5173.

Make your changes

Follow the code style guidelines below. If your changes affect how the widget is used or configured, update the documentation accordingly.

Update documentation if your changes affect usage.

Commit and push

git add .
git commit -m "Describe your changes"
git push origin feature/your-feature-name

Open a pull request

Go to your fork on GitHub and click Compare & pull request.

If you find a bug or have a feature request, open an issue on the GitHub Issues page. When reporting a bug, please include: