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.

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

docs: Updating Contributing Requirements #116

Merged
merged 4 commits into from
Jan 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/workflows/pre-commit-hook-run.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "Pre commit hook check"

on:
pull_request:
types:
- opened
- reopened
- edited
- synchronize

jobs:
pre-commit-check:
name: Pre commit hook check
runs-on: ubuntu-latest
container: rishabhpoddar/supertokens_website_sdk_testing_node_16
steps:
- uses: actions/checkout@v2
- run: git init && git add --all && git -c user.name='test' -c user.email='[email protected]' commit -m 'init for pr action'
- run: npm i --force || true
# the below command is there cause otherwise running npm run check-circular-dependencies gives an error like:
# Your cache folder contains root-owned files, due to a bug in
# npm ERR! previous versions of npm which has since been addressed.
- run: chown -R 1001:121 "/github/home/.npm"
- run: npm i --force
- run: ./hooks/pre-commit.sh
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [unreleased]
- Update contributing Prerequisites
- Remove unused ESLint and Prettier config files from TestingApp

## [4.0.8] - 2023-09-26
- use `URL` polyfill for `shouldDoInterceptionBasedOnUrl`: https://github.com/supertokens/supertokens-react-native/pull/111
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
## Development Setup
rishabhpoddar marked this conversation as resolved.
Show resolved Hide resolved

### Prerequisites
- Nodejs & npm
- **Node.js v16.x** & npm
- IDE: [VSCode](https://code.visualstudio.com/download)(recommended) or equivalent IDE

### Project Setup
Expand Down Expand Up @@ -55,11 +55,12 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
cp -r ./test/tough-cookie ./node_modules/
npm i git+https://github.com:<your username>/supertokens-react-native.git
```
5. Navigate to `supertokens-react-native/TestingApp` and run all tests
5. Add a static entry for `127.0.0.1 localhost.org` in your `/etc/hosts` file
6. Navigate to `supertokens-react-native/TestingApp` and run all tests
```
INSTALL_PATH=../../supertokens-root npm test
```
6. If all tests pass the output should be:
7. If all tests pass the output should be:

<img src="https://github.com/supertokens/supertokens-logo/blob/master/images/supertokens-react-native-tests-passing.png" alt="React Native tests passing" width="500px">

Expand Down
4 changes: 0 additions & 4 deletions TestingApp/.eslintrc.js

This file was deleted.

7 changes: 0 additions & 7 deletions TestingApp/.prettierrc.js

This file was deleted.

Loading
Loading