-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from near/feat/near-org-updates
Updates for Near Org
- Loading branch information
Showing
36 changed files
with
879 additions
and
81 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
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 |
---|---|---|
|
@@ -31,6 +31,13 @@ Please refer to `README.md` files in `src/components` for examples and documenta | |
|
||
## Contributing | ||
|
||
This project requires [pnpm](https://pnpm.io/installation) version `9.1.1`. The strict version requirement will help keep our lockfile consistent as more developers contribute. Make sure you have the correct version of `pnpm` installed: | ||
|
||
```bash | ||
pnpm -v # This should output 9.1.1 | ||
npm install -g [email protected] # Install the correct version if needed | ||
``` | ||
|
||
Run these commands to begin local development and watch for changes: | ||
|
||
```bash | ||
|
@@ -56,6 +63,16 @@ Follow these steps to preview local changes to the UI library within any project | |
|
||
_NOTE: Due to this library having peer dependencies, `pnpm link` isn't compatible - that's why we have to rely on using `file:` instead._ | ||
|
||
## Viewing Package Statistics | ||
|
||
After you've run `pnpm build` or `pnpm dev`, a `stats.html` file will be generated to show a visual breakdown of the size of the library based on source code and dependencies. You can open this in your browser by running: | ||
|
||
```bash | ||
open ./stats.html | ||
``` | ||
|
||
This can be helpful to catch or debug a dependency that might have bloated the package size. | ||
|
||
## Publishing a Release | ||
|
||
- Merge all desired changes into `main` via pull requests. | ||
|
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Oops, something went wrong.