-
-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
43 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## Contributing Guide | ||
|
||
We greatly appreciate your willingness to contribute to this project! | ||
Before submitting a pull request, there are some guidelines you should notice. | ||
|
||
### Guidelines | ||
|
||
This project is a monorepo using Turborepo, pnpm and | ||
[Changesets](https://github.com/changesets/changesets). | ||
|
||
#### Before Submitting | ||
|
||
- Check if there's other similar PRs. | ||
- Format your code with `pnpm run prettier`. | ||
- Add changesets with `pnpm changeset`, which documents the changes you've made. | ||
- Run unit tests with `pnpm test` and update snapshots if necessary. | ||
|
||
#### New Feature | ||
|
||
Before submitting a new feature, make sure to open an issue (Feature Request) with sufficient information and reasons about the new feature. | ||
After the feature request is approved, you can submit a pull request. | ||
|
||
#### Bug Fixes | ||
|
||
Provide a detailed description of the bug (with live demo if possible). | ||
OR open a bug report and link it in your PR. | ||
|
||
#### Docs | ||
|
||
Contributing to the docs is relatively easier, make sure to check the typos and grammatical mistakes before submitting. | ||
|
||
### New to contributing? | ||
|
||
You may start with contributing to the docs, | ||
it is located in `/apps/docs/content/docs`. | ||
|
||
To run the docs site in dev mode, | ||
build the dependencies with `pnpm run build --filter=./packages/*` and run `pnpm run dev --filter=docs` to start the dev server. | ||
|
||
You don't need any extra environment variables to run this project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters