Skip to content
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

docs: update contributing guide by adding upstream remote #1509

Merged
merged 8 commits into from
Dec 5, 2024
Merged

docs: update contributing guide by adding upstream remote #1509

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0896b01
update Contributing: add upstream remote
reshamas Dec 5, 2024
ef5a02c
update numbering of sections
reshamas Dec 5, 2024
6a05992
Update CONTRIBUTING.md
reshamas Dec 5, 2024
ed46f21
MG updates
reshamas Dec 5, 2024
d93842c
update numbering
reshamas Dec 5, 2024
90c4ecd
update remote from HTTP to SSH
reshamas Dec 5, 2024
4055832
minor nitpicks
MarcoGorelli Dec 5, 2024
1d0f077
Update CONTRIBUTING.md
MarcoGorelli Dec 5, 2024
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
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,28 @@ for example:
git clone [email protected]:YOUR-USERNAME/narwhals.git
```

### 3. Add the `upstream` remote
reshamas marked this conversation as resolved.
Show resolved Hide resolved
reshamas marked this conversation as resolved.
Show resolved Hide resolved

```bash
git remote add upstream [email protected]:narwhals-dev/narwhals.git
reshamas marked this conversation as resolved.
Show resolved Hide resolved
```

Check to see the remote has been added:

```bash
git remote -v
```

for example:
reshamas marked this conversation as resolved.
Show resolved Hide resolved
```bash
git remote -v
origin [email protected]:ghusername/narwhals.git (fetch)
reshamas marked this conversation as resolved.
Show resolved Hide resolved
origin [email protected]:ghusername/narwhals.git (push)
upstream https://github.com/narwhals-dev/narwhals.git (fetch)
upstream https://github.com/narwhals-dev/narwhals.git (push)
reshamas marked this conversation as resolved.
Show resolved Hide resolved
```

where `ghusername` will be your GitHub user name.

### 4. Setting up your environment

Expand Down
Loading