Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pnpm in contributing docs #355

Merged
merged 2 commits into from
May 8, 2024
Merged

Update pnpm in contributing docs #355

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c5205f
updated npm and yarn to pnpm
May 8, 2024
5c32438
added just the portion for pnpm and switched order for docs
May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 9 additions & 20 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ If the changes are larger (API design, architecture, etc), [opening an issue](ht

## Requirements
* [bazelisk](https://github.com/bazelbuild/bazelisk)
* [npm >= 8.19.2](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
* [yarn >= 1.22.19](https://yarnpkg.com/)
* [pnpm >= 8.0.0](https://pnpm.io/installation)

* [Swift >= 5.5](https://www.swift.org/download/)
* [Xcode 15.3](https://developer.apple.com/download/all/)
Expand All @@ -24,17 +23,18 @@ If the changes are larger (API design, architecture, etc), [opening an issue](ht
### Player
For speed and consistency, this repo leverages `bazel` as it's main build tool. Check out the [bazel](https://bazel.build/) docs for more info.

After forking the repo, run builds using:
After forking the repo, run builds using bazel to test, build and run:

```bash
bazel build //...
```

Tests can also be ran using:
## Docs Sites
These require the [Android NDK](https://developer.android.com/ndk).
The docs site can be ran using:

```bash
bazel test //...
bazel build //docs/site:start
bazel run //docs/site:start
```
which will run an instance on `http://localhost:3000`.


## For Android Only builds
If you are interested in only contributing for android, follow our [android guide](https://github.com/player-ui/player/blob/main/android/demo/README.md)
Expand All @@ -57,17 +57,6 @@ The demo app can also be built and launched in a simulator from the command line
bazel run //ios/demo:PlayerUIDemo
```

## Docs Sites
These require the [Android NDK](https://developer.android.com/ndk).
The docs site can be ran using:

```bash
bazel build //docs/site:start
bazel run //docs/site:start
```
which will run an instance on `http://localhost:3000`.


## Submitting a Pull Request

Prior to submitting a pull request, ensure that your fork and branch are up to date with the lastest changes on `main`.
Expand Down