Update contributing guide and improve docs #408
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
melanieseltzer
requested review from
cody-dot-js,
aaronshekey,
forzalupo and
a team
as code owners
🦋 Changeset detectedLatest commit: 412c05e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
melanieseltzer
commented
Jan 25, 2025
| 3. Enable `pnpm` with `corepack`: `corepack enable pnpm` | ||
| 4. Install `pnpm` with `corepack`: `corepack install` | ||
| 5. Install project dependencies with `pnpm`: `pnpm install` | ||
| Please read our [contribution guide](https://github.com/ngrok-oss/mantle/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
Hardcoded so it will be clickable from https://www.npmjs.com/package/@ngrok/mantle
cody-dot-js
reviewed
Jan 25, 2025
| @@ -1,4 +1,4 @@ | |||
| # ngrok Documentation Code of Conduct | |||
There was a problem hiding this comment.
lol, not surprised that this has said ngrok docs for so long
no one reads it and i def stole it from there haha
cody-dot-js
approved these changes
Jan 25, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Contributing guide rendered
Readme rendered
Cleaned up the readme for Mantle and symlinked to it from the root... GitHub renders the symlink at the root, which is really cool! Saves us having to maintain two readme files, since they're identical 🙂
Also moved local development install instructions into
CONTRIBUTING.mdand linked to it from the readme, instead of having it in there. Fleshed out the docs a little better and added stuff about changesets.