diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f8984416..42ff27814 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ Before submitting a PR, please make sure that all tests, linting and formatting rules are passing. We squash all PRs by default. You can request your PR commits to not be squashed -if the're well named and organized, and it would make sense to preserve their +if they're well named and organized, and it would make sense to preserve their context. To keep the repository clean, we may mark PRs as stale if there has been no diff --git a/SETUP.md b/SETUP.md index 9caae161a..16672c363 100644 --- a/SETUP.md +++ b/SETUP.md @@ -35,12 +35,12 @@ Update the `DATABASE_URL` variable to `postgres://passport_scorer:passport_score Update the `CERAMIC_CACHE_SCORER_ID` variable to match a `SCORER_ID` you create from the scorer UI. (You will have to complete all these setup steps first, then you will be able to create a `SCORER_ID` from the UI & update this variable.) -3. Create a new `.env` file in the `interface` directory & update the varaibles. +3. Create a new `.env` file in the `interface` directory & update the variables. ```shell # From inside the interface/ directory cp .env.example .env ``` -Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` varaible to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview) +Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` variable to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview) 4. Run and build the `Dockerfile` from the root directory. The first time you run this, it will take @@ -162,7 +162,7 @@ Copy the `.env.example` file: cp .env.example .env ``` -Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` varaible to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview) +Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` variable to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview) To start the development server: diff --git a/examples/check-trusted-user-app/README.md b/examples/check-trusted-user-app/README.md index d64e75aca..6fae7a771 100644 --- a/examples/check-trusted-user-app/README.md +++ b/examples/check-trusted-user-app/README.md @@ -6,7 +6,7 @@ from Gitcoin passport. The app is built in Nextjs using `create-next-app` and Ch ## Getting Started -This repository contains source code to accompany a "trusted user app" walkthrouhg tutorial at [docs.gitcoin.co](https://docs.passport.gitcoin.co/building-with-passport/integration-guides/integrating-stamps-and-scorers). +This repository contains source code to accompany a "trusted user app" walkthrough tutorial at [docs.gitcoin.co](https://docs.passport.gitcoin.co/building-with-passport/integration-guides/integrating-stamps-and-scorers). You can find step-by-step instructions for setting up and running this app in the tutorial. @@ -25,7 +25,7 @@ npm run dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several -stamps.Otherwise, you won't be able to do very much with this app! +stamps. Otherwise, you won't be able to do very much with this app! ## Learn More diff --git a/examples/passport-gated-content-app/README.md b/examples/passport-gated-content-app/README.md index a46c76a3f..25affe827 100644 --- a/examples/passport-gated-content-app/README.md +++ b/examples/passport-gated-content-app/README.md @@ -26,8 +26,8 @@ npm run dev Open `http://localhost:3000` with your browser to see the result. -You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several stamps.Otherwise, you won't be able to do very much with this app! +You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several stamps. Otherwise, you won't be able to do very much with this app! ## Learn More -There is a walkthrough tutorial for this app coming soon... \ No newline at end of file +There is a walkthrough tutorial for this app coming soon... diff --git a/load_tests/README.md b/load_tests/README.md index 913a5e08d..970862820 100644 --- a/load_tests/README.md +++ b/load_tests/README.md @@ -20,7 +20,7 @@ - `cd generate_test_auth_tokens` - run `npm install` -- make sure to set the environent variables: +- make sure to set the environment variables: ```bash export MNEMONIC='chief loud snack trend chief net field husband vote message decide replace' @@ -48,7 +48,7 @@ or To output results / stats in a CSV file, run k6 with the `--out` like: `k6 run -e SCORER_API_KEY='iE7QwgX9.rx9XIXdkPwZUYAHditFMgFVKvDp428OH' -e SCORER_ID=24 --vus 10 --duration 120s --out csv=k6_metrics.csv test_scripts/scorer_api_script.js` -You can then use the `stats.ipynb` to analyse the results frm the `k6_metrics.csv` (after the run). +You can then use the `stats.ipynb` to analyse the results from the `k6_metrics.csv` (after the run). ## In cloud