Skip to content

Commit c7bb44f

Browse files
rickstaadevantler
authored andcommitted
feat: improve CONTRIBUTING.md (anuraghazra#2609)
1 parent 39d386a commit c7bb44f

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

CONTRIBUTING.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
44

5-
- Reporting an issue
6-
- Discussing the current state of the code
7-
- Submitting a fix
8-
- Proposing new features
9-
- Becoming a maintainer
5+
- Reporting [an issue](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml).
6+
- [Discussing](https://github.com/anuraghazra/github-readme-stats/discussions) the current state of the code.
7+
- Submitting [a fix](https://github.com/anuraghazra/github-readme-stats/compare).
8+
- Proposing [new features](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
9+
- Becoming a maintainer.
1010

1111
## All Changes Happen Through Pull Requests
1212

@@ -33,11 +33,15 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
3333
1. Install [Vercel CLI](https://vercel.com/download).
3434
2. Fork the repository and clone the code to your local machine.
3535
3. Run `npm install` in the repository root.
36-
4. Run the command "vercel" in the root and follow the steps there.
36+
4. Run the command `vercel` in the root and follow the steps there.
3737
5. Open `vercel.json` and set the maxDuration to 10.
3838
6. Create a `.env` file in the root of the directory.
39-
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).
40-
8. Run the command "vercel dev" to start a development server at <https://localhost:3000>.
39+
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).
40+
8. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
41+
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
42+
43+
> **Note**
44+
> 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.
4145
4246
## Themes Contribution
4347

0 commit comments

Comments
 (0)