Skip to content

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

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

Open
SuyashJain17 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a5d04e1
docs: clarify upstream remote setup and fork sync steps
SuyashJain17 Jan 7, 2026
82996ad
docs: refine fork sync section structure
SuyashJain17 Jan 8, 2026
54b1ef6
Merge branch 'main' into docs-upstream-fork-sync-clean
SuyashJain17 Jan 8, 2026
1bd605a
docs: apply review feedback to fork sync section
SuyashJain17 Jan 8, 2026
37f948e
Merge branch 'main' into docs-upstream-fork-sync-clean
SuyashJain17 Jan 12, 2026
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
32 changes: 31 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,40 @@ flowchart TD
linkStyle 23 stroke:#4caf50,stroke-width:2px
linkStyle 24 stroke:#f44336,stroke-width:2px
```
### 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 Nest repository.

<details>
Copy link
Collaborator

@rudransh-shrivastava rudransh-shrivastava Jan 8, 2026

Choose a reason for hiding this comment

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

I think indenting this block might help with the visual identification of expanded content.

Copy link
Contributor Author

@SuyashJain17 SuyashJain17 Jan 8, 2026

Choose a reason for hiding this comment

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

Applied this locally.

<summary>Setting up the upstream remote</summary>

If you haven't added the upstream remote yet, add it using:

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

Verify that the upstream remote has been added by running:

```bash
git remote -v
```

This should show both `origin` (your fork) and `upstream` (the main repository) remotes.

</details>

Before working on a **new** feature or issue, update your local `main` branch from `upstream/main`:

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

### 1. Find Something to Work On

- 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)
- 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.
Expand Down