Skip to content

Commit 705e4df

Browse files
docs: correct spelling and update contributing guidelines for clarity
1 parent b6cab5f commit 705e4df

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

CONTRIBUTING.md

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

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!
44

55
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.
66

77
## Setup the Project
88

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:
1010

1111
1. Fork the repo (click the `Fork` button at the top right of [this page](https://github.com/rhinobase/hono-rate-limiter))
1212

@@ -23,22 +23,25 @@ The following steps will get you up and running to contribute to Hono Rate Limit
2323
2424
## Development
2525

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.
2727

2828
### Tooling
2929

3030
- [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
3435

3536
### Commands
3637

37-
**`pnpm install`**: bootstraps the entire project, symlinks all dependencies for cross-component development, and builds all components.
38+
**`pnpm install`**: installs all dependencies.
3839

39-
**`pnpm nx build [package name]`**: run build for a particular package.
40+
**`pnpm build`**: builds the package.
4041

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.
4245

4346
## Think you found a bug?
4447

@@ -77,7 +80,7 @@ If you are interested in the detailed specification you can visit <https://www.c
7780

7881
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.
7982

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.
8184

8285
### Tests
8386

0 commit comments

Comments
 (0)