Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.4 KB
Raw

Contributing

This document is intended for developers interested in making contributions to prefresh.

Getting Started

This steps will help you to set up your development environment.

  1. Clone the git repository: git clone git@github.com:preactjs/prefresh.git
  2. Go into the cloned folder: cd prefresh/
  3. Install all dependencies: yarn

All linting will be done in pre-commit hooks and we're using eslint + prettier for that.

How do I document a change for the changelog?

This project uses changesets. This means that for every PR there must be documentation for what has been changed and which package is affected.

You can document a change by running yarn changeset in the root, which will ask you which packages have changed and whether the change is major/minor/patch. It will then ask you to write a change entry as markdown.

Read more about adding a changeset here.

Running a fixture

Running a fixture locally can be somewhat of a pain as the paths in the package.json are meant for it being hoisted one level higher, the process we use to test locally is to adjust the local paths like file:../../packages/core to file:../../../packages/core and then run yarn, this will enable you to run this fixture locally.