System-End/github-readme-stats
1
0
Fork 0
mirror of https://github.com/System-End/github-readme-stats.git synced 2026-04-19 21:05:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: improve CONTRIBUTING.md (#2609)

Browse source
This commit is contained in:
Rick Staa 2023-04-28 04:00:13 +02:00 • committed by GitHub
parent 5577bbf07f
commit f5f0a79bc1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -2,11 +2,11 @@
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting an issue - Reporting [an issue](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml).
- Discussing the current state of the code - [Discussing](https://github.com/anuraghazra/github-readme-stats/discussions) the current state of the code.
- Submitting a fix - Submitting [a fix](https://github.com/anuraghazra/github-readme-stats/compare).
- Proposing new features - Proposing [new features](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
- Becoming a maintainer - Becoming a maintainer.
## All Changes Happen Through Pull Requests ## All Changes Happen Through Pull Requests
@ -33,11 +33,15 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
1. Install [Vercel CLI](https://vercel.com/download). 1. Install [Vercel CLI](https://vercel.com/download).
2. Fork the repository and clone the code to your local machine. 2. Fork the repository and clone the code to your local machine.
3. Run `npm install` in the repository root. 3. Run `npm install` in the repository root.
4. Run the command "vercel" in the root and follow the steps there. 4. Run the command `vercel` in the root and follow the steps there.
5. Open `vercel.json` and set the maxDuration to 10. 5. Open `vercel.json` and set the maxDuration to 10.
6. Create a `.env` file in the root of the directory. 6. Create a `.env` file in the root of the directory.
7. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). 7. In the .env file add a new variable named `PAT_1` with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
8. Run the command "vercel dev" to start a development server at <https://localhost:3000>. 8. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
> **Note**
> You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information see https://github.com/jest-community/vscode-jest/issues/912.
## Themes Contribution ## Themes Contribution