From 6d3dae4b5cbeb242a9e72186ef69ccac11c23d80 Mon Sep 17 00:00:00 2001 From: Robin Thomas Date: Thu, 24 Aug 2023 20:23:57 +0800 Subject: [PATCH 1/6] docs: add doc on how to contribute to this repo --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a0b7f194 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing + +Feel free to dive in! [Open](https://github.com/PaulRBerg/create-eth-app/issues/new/choose) an issue, +[start](https://github.com/PaulRBerg/create-eth-app/discussions/new/choose) a discussion or submit a PR. + +Contributions to `create-eth-app` are welcome by anyone interested in adding support for more frameworks or DEFI templates, writing more tests, improving readability, or improving the documentation. + +## Pre Requisites + +You will need the following software on your machine: + +- [Git](https://git-scm.com/downloads) +- [Node.Js](https://nodejs.org/en/download/) +- [Yarn](https://yarnpkg.com/) + +## Set Up + +1. Fork this repository by visiting https://github.com/PaulRBerg/create-eth-app/fork + +2. Once the fork is created, head to the forked repo. For example, [this](https://github.com/robin-thomas/create-eth-app) is a fork of the original repo. + +3. Go to `Settings` tab of the forked repo. Under `Security` subheader, click on `Secrets and variables`, and click on `Actions`. + +4. Click on the `New repository secret` button, and add the following secrets: + - `GH_OAUTH_TOKEN`: Your fine-grained personal access token + +5. You can create a token by visiting: https://github.com/settings/personal-access-tokens/new + - Enter the token name as: `create-eth-app` + - Make sure `Only select repositories` option is selected, and choose your forked repo. + - Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` + - Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. + +6. Clone the forked repo to your local machine + +7. Then, inside the project's directory, run this to install the Node.js dependencies: +```bash +$ yarn install --frozen-lockfile +``` + +Now you can start making changes. From 522b498baeaa04798a78c366052d57b3e02cb3dd Mon Sep 17 00:00:00 2001 From: Robin Thomas Date: Fri, 25 Aug 2023 09:20:11 +0800 Subject: [PATCH 2/6] docs: run prettier --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0b7f194..34914490 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,17 +22,20 @@ You will need the following software on your machine: 3. Go to `Settings` tab of the forked repo. Under `Security` subheader, click on `Secrets and variables`, and click on `Actions`. 4. Click on the `New repository secret` button, and add the following secrets: + - `GH_OAUTH_TOKEN`: Your fine-grained personal access token 5. You can create a token by visiting: https://github.com/settings/personal-access-tokens/new - - Enter the token name as: `create-eth-app` - - Make sure `Only select repositories` option is selected, and choose your forked repo. - - Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` - - Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. + +- Enter the token name as: `create-eth-app` +- Make sure `Only select repositories` option is selected, and choose your forked repo. +- Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` +- Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. 6. Clone the forked repo to your local machine 7. Then, inside the project's directory, run this to install the Node.js dependencies: + ```bash $ yarn install --frozen-lockfile ``` From 070aa95145f32d005239c95476dbd14573a76f60 Mon Sep 17 00:00:00 2001 From: Robin Thomas Date: Fri, 25 Aug 2023 09:26:02 +0800 Subject: [PATCH 3/6] docs: update permissions for PAT --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34914490..84dc78ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,7 @@ You will need the following software on your machine: - Enter the token name as: `create-eth-app` - Make sure `Only select repositories` option is selected, and choose your forked repo. +- Enable the `Environments` permission under `Repository permissions` section, by choosing `Read and write` - Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` - Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. From a29d3ee9a0dd12110efafc463bf49b7b7d9fc6d9 Mon Sep 17 00:00:00 2001 From: Robin Thomas Date: Fri, 25 Aug 2023 10:13:55 +0800 Subject: [PATCH 4/6] docs: update permissions for PAT --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84dc78ba..34914490 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,6 @@ You will need the following software on your machine: - Enter the token name as: `create-eth-app` - Make sure `Only select repositories` option is selected, and choose your forked repo. -- Enable the `Environments` permission under `Repository permissions` section, by choosing `Read and write` - Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` - Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. From 8526c30ea569811ac4e1a2fb48b0b657f9d7f3e9 Mon Sep 17 00:00:00 2001 From: Robin Thomas Date: Fri, 25 Aug 2023 17:08:25 +0800 Subject: [PATCH 5/6] docs: remove portion about secrets --- CONTRIBUTING.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34914490..f9526c0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,22 +19,9 @@ You will need the following software on your machine: 2. Once the fork is created, head to the forked repo. For example, [this](https://github.com/robin-thomas/create-eth-app) is a fork of the original repo. -3. Go to `Settings` tab of the forked repo. Under `Security` subheader, click on `Secrets and variables`, and click on `Actions`. +3. Clone the forked repo to your local machine -4. Click on the `New repository secret` button, and add the following secrets: - - - `GH_OAUTH_TOKEN`: Your fine-grained personal access token - -5. You can create a token by visiting: https://github.com/settings/personal-access-tokens/new - -- Enter the token name as: `create-eth-app` -- Make sure `Only select repositories` option is selected, and choose your forked repo. -- Enable the `Secrets` permission under `Repository permissions` section, by choosing `Read-only` -- Use the token generated in the previous step as the value for `GH_OAUTH_TOKEN` secret. - -6. Clone the forked repo to your local machine - -7. Then, inside the project's directory, run this to install the Node.js dependencies: +4. Then, inside the project's directory, run this to install the Node.js dependencies: ```bash $ yarn install --frozen-lockfile From cfb2e918ae8d753fd6055757c00c5d2eddbce7ca Mon Sep 17 00:00:00 2001 From: Paul Razvan Berg Date: Mon, 28 Aug 2023 13:38:33 +0300 Subject: [PATCH 6/6] docs: update formatting --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9526c0a..e5efe855 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Feel free to dive in! [Open](https://github.com/PaulRBerg/create-eth-app/issues/new/choose) an issue, [start](https://github.com/PaulRBerg/create-eth-app/discussions/new/choose) a discussion or submit a PR. -Contributions to `create-eth-app` are welcome by anyone interested in adding support for more frameworks or DEFI templates, writing more tests, improving readability, or improving the documentation. +Contributions to `create-eth-app` are welcome by anyone interested in adding support for more frameworks or DeFi templates, writing more tests, improving readability, or improving the documentation. ## Pre Requisites @@ -16,11 +16,8 @@ You will need the following software on your machine: ## Set Up 1. Fork this repository by visiting https://github.com/PaulRBerg/create-eth-app/fork - 2. Once the fork is created, head to the forked repo. For example, [this](https://github.com/robin-thomas/create-eth-app) is a fork of the original repo. - 3. Clone the forked repo to your local machine - 4. Then, inside the project's directory, run this to install the Node.js dependencies: ```bash