Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.26 KB

Svelte Meta Tags Contributing Guide

Hi! We are really excited that you are interested in contributing to Svelte Meta Tags. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Project Set Up

It requires the use of pnpm. You can install pnpm with:

npm i -g pnpm
  1. Pull the repo and install the dependencies:
git clone [email protected]:oekazuma/svelte-meta-tags.git
pnpm install
  1. Make your modifications / additions
  2. Update / Add Documentation
  3. Write / Update Tests. End to end tests are required for all changes and new features.
  4. Open pull request

Work with Svelte Meta Tags

All the code for the library is located in the src/lib directory.

The src/routes directory contains a fully working SvelteKit app. This will be used for end-to-end testing. You can run pnpm dev to run this app. You can also run it in a production build by running pnpm build and pnpm preview.

To run Playwright, you can run pnpm test.

Releases

The Changesets GitHub action will create and update a PR that applies changesets and publishes new versions of changed packages to npm.