Merge branch 'master' of https://github.com/saberzero1/github-profile…

…-trophy into saberzero1-patch-1

.github/workflows/testing.yml

@@ -0,0 +1,30 @@
+name: Check PR Test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  install-dependencies:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        deno-version: [1.36.1]
+
+    steps:
+      - name: Git Checkout Deno Module
+        uses: actions/checkout@v2
+      - name: Use Deno Version ${{ matrix.deno-version }}
+        uses: denolib/setup-deno@v2
+        with:
+          deno-version: ${{ matrix.deno-version }}
+      - name: Deno format check
+        run: deno fmt --check
+      - name: Deno lint check
+        run: deno task lint
+      - name: Test Deno Module
+        run: deno task test

.gitignore

@@ -1,3 +1,6 @@
 .vscode
 .env
 .idea
+deno.lock
+*.sh
+**/.DS_Store

CONTRIBUTING.md

@@ -2,25 +2,39 @@
 
 ## Environment
 
-* Deno >= v1.9.2
-* [Vercel](https://vercel.com/)
-* GitHub API v4
+- Deno >= v1.36.1
+- [Vercel](https://vercel.com/)
+- GitHub API v4
+- Docker and Docker compose (optional)
 
 ## Local Run
 
-Create `.env` file to project root directory, and write your GitHub token to the `.env` file.
-Please select the authority of `repo` when creating token.
+Create `.env` file to project root directory, and write your GitHub token to the
+`.env` file. Please select the authority of `repo` when creating token.
 
-```
-GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```properties
+GITHUB_TOKEN1=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+GITHUB_TOKEN2=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+# if using GitHub Enterprise:
+# (this env var defaults to https://api.github.com/graphql)
+GITHUB_API=https://github.example.com/api/graphql
 ```
 
 Run local server.
 
+```sh
+deno task start
 ```
-deno run --allow-net --allow-read --allow-env debug.ts
+
+You can enable the Redis if you want, but it's not mandatory.
+
+```sh
+docker compose up -d
 ```
 
+Rename `env-example` to `.env`, and change ENABLE_REDIS to true
+
 Open localhost from your browser.
 
 http://localhost:8080/?username=ryo-ma
@@ -29,10 +43,31 @@ http://localhost:8080/?username=ryo-ma
 
 Read the [.editorconfig](./.editorconfig)
 
+## Pull Requests
+
+Pull requests are are always welcome! In general, they should a single concern
+in the least number of changed lines as possible. For changes that address core
+functionality, it is best to open an issue to discuss your proposal first. I
+look forward to seeing what you come up with!
+
 ## Run deno lint
 
-If you want to contribute to my project, you should check the lint with the following command.
+## What to do before contributing
+
+### 1. Run deno lint
+
+```sh
+deno task lint
+```
+
+### 2. Run deno fmt
+
+```sh
+deno task fmt
+```
+
+### 3. Run deno test
 
+```sh
+deno task test
 ```
-deno lint --unstable
-```