Skip to content

Commit 7ccf443

Browse files
committed
Update contributing.md
1 parent b3002fa commit 7ccf443

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"editor.tabSize": 2,
3+
"editor.insertSpaces": true,
34
"[javascript]": {
45
"editor.defaultFormatter": "vscode.typescript-language-features",
56
},

docs/contributing.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Contributing
22

3-
Currently [I'm](https://hire.jonasgalvez.com.br) the sole maintainer of this project.
4-
53
New contributors would be extremely welcome.
64

7-
The project needs at least an additional releaser.
5+
## How to publish a new version
6+
7+
This repository uses [changesets](https://github.com/changesets/changesets) to automate its versioning and release process. When contributing to this repo, your pull request should contain a "changeset" that can be generated by running `pnpm changeset` from your branch locally.
8+
9+
The changeset CLI will ask you to enter the corresponding semver bump type and a description of your changes: feel free to enter a brief description via the command line and continue editing the generated Markdown file found inside of the `.changeset` directory in your editor of choice. When editing your changeset's Markdown file, you can leverage any of the features of GitHub flavored markdown! The description you provide in your changeset will be used to generate an entry in CHANGELOG.md and the release notes in a future release, so the more complete and descriptive the better.
810

9-
GitHub issues need more active triaging.
11+
In summary, before you submit a pull request, perform the following steps:
1012

11-
Both **`@fastify/vue`** and **`@fastify/react`** are lacking a comprehensive test suite and more starter templates covering other potential configurations.
13+
1. Run `pnpm changeset`
14+
2. Answer the questions in the interactive prompt.
15+
3. Commit the changes.
1216

13-
## Style
17+
## Formatting & Linting
18+
19+
This project uses [oxlint](https://oxc.rs/docs/guide/usage/linter.html) to lint. Unfortunately, the oxc formatter is not yet available nor are there any VSCode extensions ready for use yet.
1420

1521
Please make sure to adhere to the following style conventions:
1622

@@ -19,12 +25,10 @@ Please make sure to adhere to the following style conventions:
1925
- **Two-space indendation **
2026
- **Singlequoted strings**
2127

22-
We use [`oxc`](https://oxc.rs/) which is extremely fast but doesn't perform this type of formatting.
28+
If you use VSCode, the included `.vscode/settings.json` should be able to perform the formatting necessary for now as we wait for the oxc formatter to and its corresponding VSCode extension to be released.
2329

24-
## Development
30+
## Development & Testing
2531

2632
**`@fastify/vite`**, **`@fastify/vue`** and **`@fastify/react`** live in the [same monorepo](https://github.com/fastify/fastify-vite) and are set up to work as a [**pnpm workspace**](https://pnpm.io/workspaces).
2733

28-
The `examples/` also serve as test suites, make sure to run `source ./test-all.sh` from that folder after making changes to `@fastify/vite`.
29-
30-
Last Updated: **November 23, 2023**
34+
The `examples/` also serve as test suites. Running `pnpm test` from the root folder after making changes to `@fastify/vite` will run the tests for all examples.

0 commit comments

Comments
 (0)