From a5d04e1fce07ac68513e1aecc967e3e2dd1cf243 Mon Sep 17 00:00:00 2001 From: Suyash Jain Date: Wed, 7 Jan 2026 16:21:03 +0530 Subject: [PATCH 1/4] docs: clarify upstream remote setup and fork sync steps --- CONTRIBUTING.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53b8936f86..46f88adb5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -491,10 +491,47 @@ 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 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. ### 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. From 82996ad1fde954637b51c0ae6b64b8a9a893f667 Mon Sep 17 00:00:00 2001 From: Suyash Jain Date: Thu, 8 Jan 2026 20:52:31 +0530 Subject: [PATCH 2/4] docs: refine fork sync section structure --- CONTRIBUTING.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46f88adb5f..6c60c0e79e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -495,31 +495,26 @@ flowchart TD 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) +
+Setting up the upstream remote -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`: +If you haven't added the upstream remote yet, you can add it using: ```bash git remote add upstream https://github.com/OWASP/Nest.git ``` -You can verify the remotes again: +You can verify that the upstream remote has been added by running: ```bash git remote -v ``` -You should now see both `origin` (your fork) and `upstream` (OWASP/Nest). +This will show both your `origin` (your fork) and `upstream` (the main repository) remotes. -#### 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`: +Before working on a **new** feature or issue, update your local `main` branch from `upstream/main`: ```bash git checkout main @@ -527,8 +522,6 @@ 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. - ### 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) From 1bd605a57028413a641495ef4587380ae72b440e Mon Sep 17 00:00:00 2001 From: Suyash Jain Date: Thu, 8 Jan 2026 22:03:21 +0530 Subject: [PATCH 3/4] docs: apply review feedback to fork sync section --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c60c0e79e..9fa836cca4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -493,24 +493,24 @@ flowchart TD ``` ### 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. +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.
Setting up the upstream remote -If you haven't added the upstream remote yet, you can add it using: +If you haven't added the upstream remote yet, add it using: ```bash git remote add upstream https://github.com/OWASP/Nest.git ``` -You can verify that the upstream remote has been added by running: +Verify that the upstream remote has been added by running: ```bash git remote -v ``` -This will show both your `origin` (your fork) and `upstream` (the main repository) remotes. +This should show both `origin` (your fork) and `upstream` (the main repository) remotes.
From 4cba55baf60604eb163b61218c667cabf4590a28 Mon Sep 17 00:00:00 2001 From: Arkadii Yakovets Date: Sat, 17 Jan 2026 16:27:57 -0800 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fa836cca4..a5c7f510ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -491,6 +491,7 @@ 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.