vacuum-card/CONTRIBUTING.md

Vacuum cleaner card for Home Assistant Lovelace UI

# Contributing

If you plan to contribute back to this repo, please fork & open a PR.

## How to add translation

Only native speaker can translate to specific language.

1. Copy `src/translations/en.json` file and name it with appropriate language code.
2. Translate only keys in this file, not values.
3. Import your translation in `src/localize.js` file.
4. Mention your translation in `README.md` file.
5. Open a PR.
6. Find someone to check and approve your PR.

## How to run locally

1. Clone this repo to wherever you want:
   ```sh
   git clone https://github.com/denysdovhan/vacuum-card.git
   ```
2. Go into the repo folder:
   ```sh
   cd vacuum-card
   ```
3. Install dependencies (Node.js and npm are required):
   ```sh
   npm install
   ```
4. Run development server. It's going to watch source files, recompile on changes and server compiled file on local server.
   ```sh
   npm start
   ```
5. Add `http://localhost:5000/vacuum-card.js` to your Lovelace resources.

Now you can make changes to files in `src` folder. Development server will automatically rebuild on changes. Lovelace will load resource from development server. Refresh the browser to see changes. Make sure cache is cleared or disabled.

## Release process

1. Merge PRs into `main`. Release Drafter updates the draft release on each `main` push.
2. Edit the draft release notes if needed.
3. Publish the release with a tag like `vX.Y.Z`.
4. Publishing triggers the release workflow to build the project, publish to npm, and upload `dist/vacuum-card.js` to the GitHub release.