Skip to content

Docs: clarify upstream remote setup and fork sync steps for contributors #3234

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

Closed
SuyashJain17 wants to merge 1 commit into from
Closed

Docs: clarify upstream remote setup and fork sync steps for contributors #3234

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
42 changes: 40 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,14 +492,52 @@ flowchart TD
linkStyle 24 stroke:#f44336,stroke-width:2px
```

### 1. Find Something to Work On
### Keep Your Fork in Sync with Upstream

To avoid working on an outdated copy of Nest (and to reduce merge conflicts), contributors may find it helpful to keep their fork synchronized with the main OWASP repository.

#### 1. Add the upstream remote (one-time setup)

After cloning your fork locally and moving into the project directory:

```bash
git remote -v
```

If you do not see a remote named `upstream`, add the official OWASP Nest repository as `upstream`:

```bash
git remote add upstream https://github.com/OWASP/Nest.git
```

You can verify the remotes again:

```bash
git remote -v
```

You should now see both `origin` (your fork) and `upstream` (OWASP/Nest).

#### 2. Sync your local main and your fork before starting new work

Before starting a **new** feature or issue, you may want to update your local `main` from `upstream/main`:

```bash
git checkout main
git fetch upstream
git merge upstream/main
```

Following this flow ensures that new branches start from the latest `upstream/main`, which helps avoid unnecessary rebases during review.

### Find Something to Work On

- Check the **Issues** tab for open issues: [https://github.com/owasp/nest/issues](https://github.com/owasp/nest/issues)
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Capitalize repository reference for consistency.

Line 535 uses lowercase owasp/nest in the GitHub URL, while all other OWASP/Nest references in this file (lines 30, 34, 379, 409, 410, 510) use proper capitalization OWASP/Nest. Update for consistency:

- Check the **Issues** tab for open issues: [https://github.com/owasp/nest/issues](https://github.com/owasp/nest/issues)
+ Check the **Issues** tab for open issues: [https://github.com/OWASP/Nest/issues](https://github.com/OWASP/Nest/issues)

Also applies to: 535-535

🤖 Prompt for AI Agents 
In @CONTRIBUTING.md at line 535, The repository URL text
'https://github.com/owasp/nest/issues' is lowercased and should be updated to
use the same capitalization as other references; replace that string with
'https://github.com/OWASP/Nest/issues' so the repository reference reads
OWASP/Nest consistently in the CONTRIBUTING.md (the specific occurrence is the
URL text on the checked line).

- Found a bug or have a feature request? Open a new issue.
- Want to work on an existing issue? Ask the maintainers to assign it to you before submitting a pull request.
- New to the project? Start with issues labeled `good first issue` for an easier onboarding experience.

### 2. Create a Branch
### Create a Branch

Always create a feature branch for your work:

Expand Down