Skip to content

Commit

Permalink
chore: update contributing guide and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Ernxst committed Jun 22, 2024
1 parent e7fded1 commit 7365276
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 8 deletions.
25 changes: 21 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,16 @@ though, please make sure to take a moment and read through the following guideli
### Prerequisite

```shell
node: ">= 18.12.0"
bun: "^1.0.6"
node: ">= 20.0.0"
bun: "^1.1.15"
# otherwise, your build will fail
```

### Setting up your local repo

```shell
git clone && cd ...
bun install -y
bun install
bun run build
```

Expand Down Expand Up @@ -127,7 +127,8 @@ bunx changeset

This project has a simple structure,

<!-- TODO: Code structure -->
- [`examples/`](/examples/) - Apps showing example usage of the library
- [`packages/`](/packages/) - Library code

## Releases

Expand All @@ -137,6 +138,22 @@ The repo is set up with automatic releases, using the changeset GitHub action &

To release a new version of `svelte-query-params`, find the `Version Packages` PR, read it over, and merge it.

### Changesets

[Changesets](https://github.com/changesets/changesets) is a tool that helps us keep a changelog for all the packages in the monorepo and aggregate them into release notes.

To add a changeset:

1. **Run the command** `bunx changeset` in your terminal
2. **Select packages** affected by your change; we have a dedicated package for the docs.
3. **Classify the change** as major, minor, or patch for each selected package.
4. **Write the changelog** as detailing WHAT the change is, WHY it was made, and HOW it affects the users.
5. **Commit the changeset file** to your Git branch so that it appears in your PR.

Make an effort to write the changelog well, because our users see this in the release notes. Provide enough detail to be clear, but keep things as concise as possible. If migration steps are required, detail them here.

A detailed guide on adding changesets can be [found here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).

### Releasing PR preview snapshots

Our release tool `changeset` has a feature for releasing "snapshot" releases from a PR or custom branch. These are npm package publishes that live temporarily, so that you can give users a way to test a PR before merging. This can be a great way to get early user feedback while still in the PR review process.
Expand Down
20 changes: 16 additions & 4 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
MIT License

Copyright (c) Ernest Nkansah-Badu <ernestjbadu@outlook.com> (<https://ernestbadu.dev>)
Copyright (c) 2023 - present, Ernest Nkansah-Badu and svelte-query-params contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

0 comments on commit 7365276

Please sign in to comment.