Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheu committed Nov 1, 2024
1 parent 4a21a42 commit 0878946
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing.

## Building assets

Run `npm run build` to build production assets, or `npm run start` whilst actively working on the plugin.,

There is currently no automated process to build assets when releasing, so please commit updated build files as part of any pull request. This is something we can revisit later if it becomes an issue.

## Releasing a new version

[Releases are managed using Github.](https://github.com/humanmade/query-filter/releases).

Create a new release setting the tag to the desired version number (Follow semver for major/minor releases). Target should be main and release notes can be auto-generated. Use the version number as the release title.

Once a release is created, it will be published automatically on Packagist.

0 comments on commit 0878946

Please sign in to comment.