Skip to content

Commit

Permalink
update CONTRIBUTING doc with more system info, update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
hborawski committed Sep 29, 2023
1 parent 24a7f7b commit c7f712f
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ assignees: ""
**To Reproduce**

<!-- Steps to reproduce the behavior: -->
<!-- If possible JSON content utilizing reference assets to illustrate the issue -->

**Expected behavior**

Expand Down
25 changes: 21 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,27 @@ Make sure to add:
-->


### Change Type (required)
Indicate the type of change your pull request is:

<!--
Does the change need more description than just he PR title?
Uncomment the line below and write some release notes
We use semantic versioning: https://semver.org/. Review that documentation for
more detailed guidelines.
-->
- [ ] `patch`
- [ ] `minor`
- [ ] `major`

<!--
To include release notes in the automatic changelong, just add a level 1 markdown header below
and include any markdown notes to go into the changelog: https://intuit.github.io/auto/docs/generated/changelog#additional-release-notes
Example:
<!-- ## Release Notes -->
<!-- <release notes here> -->
# Release Notes
Added new plugin, to use it:
```typescript
const plugin = new Plugin(...)
```
-->
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,25 @@ If the changes are larger (API design, architecture, etc), [opening an issue](ht
## Requirements
* [npm >= 8.19.2](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
* [yarn >= 1.22.19](https://yarnpkg.com/)

* [Swift >= 5.2](https://www.swift.org/download/)
* [Xcode 14.3](https://developer.apple.com/download/all/)
* [Ruby >= 2.6 && <= 3.0](https://github.com/rbenv/rbenv)

* [Android NDK >= 19.2.5345600, <= 21](https://github.com/android/ndk/wiki/Unsupported-Downloads#r19c). Any version > 21 will not work, period. You'll need to add `ANDROID_NDK_HOME` to your environment manually.

## Building and Testing Locally
#### Presetup
For iOS builds, some pre-setup is required for `bazel` to generate BUILD files for dependent CocoaPods.

```bash
bundle install
```
CocoaPods does not directly integrate with `bazel`, when core targets are updated, the output bundles need to be copied to the location described in the `PlayerUI.podspec`, to do so run the script:
```bash
./tools/build_ios_bundles.sh
```
This will query `bazel` for dependent targets, copy their output and regenerate the `.xcworkspace`.
### 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.

Expand All @@ -30,6 +45,13 @@ Tests can also be ran using:
bazel test //...
```

#### Skipping iOS builds
The `.bazelrc` contains a convenience to build everything but the iOS targets, as the toolchain for those is platform specific.

```bash
bazel build --config=skip-ios
```

### Docs Sites
These require the [Android NDK](https://developer.android.com/ndk).
The docs site can be ran using:
Expand All @@ -43,7 +65,9 @@ which will run an instance on `http://localhost:3000`.

## Submitting a Pull Request

Please ensure that any new features have sufficient tests, code coverage, and documentation.
Prior to submitting a pull request, ensure that your fork and branch are up to date with the lastest changes on `main`.

Any new features should have corresponding tests that exercise all code paths, and public symbols should have docstrings at a minimum. For more complex features, adding new documentation pages to the site to help guide users to consume the feature would be preferred.

When you're ready, submit a new pull request to the `main` branch and the team will be notified of the new requested changes. We'll do our best to respond as soon as we can.

Expand Down

0 comments on commit c7f712f

Please sign in to comment.