Skip to content

Update CONTRIBUTING.md for new repo name #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattIPv4 merged 1 commit into from
Aug 14, 2025
Merged

Update CONTRIBUTING.md for new repo name #399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,28 @@ The steps below will give you a general idea of how to prepare your local enviro

1. **Fork the repository**

Click the fork button in the top right, or the link in this paragraph, to clone the [Node.js `api-docs-tooling` Repository](https://github.com/nodejs/api-docs-tooling/fork)
Click the fork button in the top right, or the link in this paragraph, to clone the [Node.js `doc-kit` Repository](https://github.com/nodejs/doc-kit/fork)

2. **Clone your fork**

```bash
git clone git@github.com:<YOUR_GITHUB_USERNAME>/api-docs-tooling.git # SSH
git clone https://github.com/<YOUR_GITHUB_USERNAME>/api-docs-tooling.git # HTTPS
gh repo clone <YOUR_GITHUB_USERNAME>/api-docs-tooling # GitHub CLI
git clone git@github.com:<YOUR_GITHUB_USERNAME>/doc-kit.git # SSH
git clone https://github.com/<YOUR_GITHUB_USERNAME>/doc-kit.git # HTTPS
gh repo clone <YOUR_GITHUB_USERNAME>/doc-kit # GitHub CLI
```

3. **Navigate to the project directory**

```bash
cd api-docs-tooling
cd doc-kit
```

4. **Set up upstream remote**

```bash
git remote add upstream git@github.com:nodejs/api-docs-tooling # SSH
git remote add upstream https://github.com/nodejs/api-docs-tooling # HTTPS
gh repo sync nodejs/api-docs-tooling # GitHub CLI
git remote add upstream git@github.com:nodejs/doc-kit # SSH
git remote add upstream https://github.com/nodejs/doc-kit # HTTPS
gh repo sync nodejs/doc-kit # GitHub CLI
```

5. **Install dependencies**
Expand Down
Loading