docs: add CONTRIBUTING.md #1043
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
commit: |
dai-shi
reviewed
Jan 26, 2025
CONTRIBUTING.md
Outdated
Comment on lines
72
to
82
| ## Valtio-specific Guideline | ||
|
|
||
| ##### Documentation | ||
|
|
||
| 1. Navigate to the [`website`](./website/) folder. (e.g., `cd website`) | ||
| 2. Install dependencies by running `pnpm install` in the `website` folder | ||
| 3. Run `pnpm run dev` to start the dev server | ||
| 4. Navigate to [`http://localhost:3000`](http://localhost:3000) to view the documents | ||
| 5. Navigate to the [`docs`](./docs/) folder and make necessary changes to the documents. | ||
| 6. Add your changes to the documents and see them live reloaded in the browser | ||
| 7. Follow step 4 and onwards from the [General](#General) guide above to bring it to the finish line |
There was a problem hiding this comment.
@overthemike Can you review this section?
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Check List
pnpm run fix:formatfor formatting code and docs