Skip to content

Commit

Permalink
docs: add personal access token instructions to dev guidelines (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbudzins authored May 19, 2022
1 parent f9eaa71 commit 7b0b0ae
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Thanks for considering contributing to our repo! We appreciate all contributions to the app, large or small. Please take the time to read through this document before making a contribution to ensure a fun and effective process for everyone involved.

You can read the [Developer Guidelines](./docs/developer-guidelines.md) for advice on how to get your development environment setup.

## General guidelines

Are you having trouble getting started with the OTT Web App, configuration, or customization? If so, please check the [developer docs](https://github.com/jwplayer/ott-web-app/tree/develop/docs) before submitting an issue here.
Expand Down
9 changes: 1 addition & 8 deletions docs/developer-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,7 @@
- Format the code through `yarn format`
- Lint through `yarn lint`
- Lint and fix through `yarn lint --fix`

## How to use the create-base script

The `yarn create-base` can be used to quickly scaffold a component, container or screen.

- use `yarn create-base components/YourComponentName` to create a base component
- use `yarn create-base containers/YourContainerName` to create a base container
- use `yarn create-base screens/YourScreenName` to create a base screen
- The JW organization requires personal access tokens for all of their repositories. In order to create a branch or pull request you'll need to [Generate a Personal Access Token](https://github.com/settings/tokens) and then [store it in your git config](https://stackoverflow.com/questions/46645843/where-to-store-my-git-personal-access-token/67360592). (For token permissions, `repo` should be sufficient.)

## Git Commit Guidelines (conventional changelog)

Expand Down

0 comments on commit 7b0b0ae

Please sign in to comment.