mirror of
https://github.com/reiyua/github-profile-trophy-reiyua-mirror.git
synced 2026-11-17 06:02:09 +11:00
moved contribution guidelines into separate file (#127)
This commit is contained in:
parent
b093822e8b
commit
94f9b41814
2 changed files with 39 additions and 37 deletions
38
CONTRIBUTING.md
Normal file
38
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
# Contribution Guide
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
* Deno >= v1.9.2
|
||||||
|
* [Vercel](https://vercel.com/)
|
||||||
|
* GitHub API v4
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
```
|
||||||
|
GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||||||
|
```
|
||||||
|
|
||||||
|
Run local server.
|
||||||
|
|
||||||
|
```
|
||||||
|
deno run --allow-net --allow-read --allow-env debug.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
Open localhost from your browser.
|
||||||
|
|
||||||
|
http://localhost:8080/?username=ryo-ma
|
||||||
|
|
||||||
|
## Editor config
|
||||||
|
|
||||||
|
Read the [.editorconfig](./.editorconfig)
|
||||||
|
|
||||||
|
## Run deno lint
|
||||||
|
|
||||||
|
If you want to contribute to my project, you should check the lint with the following command.
|
||||||
|
|
||||||
|
```
|
||||||
|
deno lint --unstable
|
||||||
|
```
|
||||||
38
README.md
38
README.md
|
|
@ -484,40 +484,4 @@ https://github-profile-trophy.vercel.app/?username=ryo-ma&no-frame=true
|
||||||
|
|
||||||
|
|
||||||
# Contribution Guide
|
# Contribution Guide
|
||||||
|
Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
|
||||||
## Environment
|
|
||||||
|
|
||||||
* Deno >= v1.9.2
|
|
||||||
* [Vercel](https://vercel.com/)
|
|
||||||
* GitHub API v4
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
```
|
|
||||||
GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
|
||||||
```
|
|
||||||
|
|
||||||
Run local server.
|
|
||||||
|
|
||||||
```
|
|
||||||
deno run --allow-net --allow-read --allow-env debug.ts
|
|
||||||
```
|
|
||||||
|
|
||||||
Open localhost from your browser.
|
|
||||||
|
|
||||||
http://localhost:8080/?username=ryo-ma
|
|
||||||
|
|
||||||
## Editor config
|
|
||||||
|
|
||||||
Read the [.editorconfig](./.editorconfig)
|
|
||||||
|
|
||||||
## Run deno lint
|
|
||||||
|
|
||||||
If you want to contribute to my project, you should check the lint with the following command.
|
|
||||||
|
|
||||||
```
|
|
||||||
deno lint --unstable
|
|
||||||
```
|
|
||||||
Loading…
Add table
Reference in a new issue