Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiodxa authored Jul 30, 2021
1 parent 8d07cdf commit a6b28f8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contribution

## Setup

Create an environment variable called `REMIX_TOKEN` with your [Remix install token](https://remix.run/dashboard).

Run `npm install` to install the dependencies.

Run the tests with `npm run test`.

Run the linter with `npm run lint`.

Run the typechecker with `npm run typecheck`.

## Create a Strategy

Follow the steps on the [Create a Strategy](https://github.com/sergiodxa/remix-auth/blob/main/docs/create-a-strategy.md) documentation. Create your new strategy inside the folder [`src/strategies`](https://github.com/sergiodxa/remix-auth/tree/main/src/strategies) and re-export it from the `index.ts` file.

0 comments on commit a6b28f8

Please sign in to comment.