You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Contributing
2
2
3
-
Thanks for showing interest in contributing to Hono Rate Limitter 💖, you rock!
3
+
Thanks for showing interest in contributing to Hono Rate Limiter 💖, you rock!
4
4
5
5
When it comes to open source, you can contribute in different ways, all of which are valuable. Here are a few guidelines that should help you prepare your contribution.
6
6
7
7
## Setup the Project
8
8
9
-
The following steps will get you up and running to contribute to Hono Rate Limitter:
9
+
The following steps will get you up and running to contribute to Hono Rate Limiter:
10
10
11
11
1. Fork the repo (click the `Fork` button at the top right of [this page](https://github.com/rhinobase/hono-rate-limiter))
12
12
@@ -23,22 +23,25 @@ The following steps will get you up and running to contribute to Hono Rate Limit
23
23
24
24
## Development
25
25
26
-
To improve our development process, we’ve set up tooling and systems, and Hono Rate Limitter uses a mono repo structure by `nx`.
26
+
To improve our development process, we’ve set up tooling and systems, and Hono Rate Limiter is a single package with a straightforward structure.
27
27
28
28
### Tooling
29
29
30
30
-[PNPM](https://pnpm.io/) to manage packages and dependencies
31
-
-[NX](https://nx.dev/) to manage the monorepo
32
-
-[SWC](https://swc.rs/) to bundle packages
33
-
-[Changeset](https://github.com/atlassian/changesets) for changes documentation, changelog generation, and release management.
31
+
-[pkgroll](https://github.com/privatenumber/pkgroll) to bundle the package
32
+
-[Biome](https://biomejs.dev/) for formatting and linting
33
+
-[Vitest](https://vitest.dev/) for testing
34
+
-[Husky](https://typicode.github.io/husky/) for git hooks
34
35
35
36
### Commands
36
37
37
-
**`pnpm install`**: bootstraps the entire project, symlinks all dependencies for cross-component development, and builds all components.
38
+
**`pnpm install`**: installs all dependencies.
38
39
39
-
**`pnpm nx build [package name]`**: run build for a particular package.
40
+
**`pnpm build`**: builds the package.
40
41
41
-
**`pnpm nx run-many -t build`**: run build for all the packages.
42
+
**`pnpm test`**: runs the test suite.
43
+
44
+
**`pnpm format`**: formats and lints code with Biome.
42
45
43
46
## Think you found a bug?
44
47
@@ -77,7 +80,7 @@ If you are interested in the detailed specification you can visit <https://www.c
77
80
78
81
2. Create a new branch out of the `main` branch. We follow the convention `[type/scope]`. For example `fix/memcache` or `docs/core`. `type` can be either `docs`, `fix`, `feat`, `build`, or any other conventional commit type. `scope` is just a short id that describes the scope of work.
79
82
80
-
3. Make and commit your changes following the [commit convention](https://github.com/rhinobase/raftyui/blob/main/CONTRIBUTING.md#commit-convention). As you develop, you can run `pnpm nx build [package name]` to make sure everything works as expected.
83
+
3. Make and commit your changes following the [commit convention](https://github.com/rhinobase/hono-rate-limiter/blob/main/CONTRIBUTING.md#commit-convention). As you develop, you can run `pnpm build` and `pnpm test` to make sure everything works as expected.
0 commit comments