Skip to content

Commit bf345da

Browse files
Docs: clarify upstream remote setup and fork sync steps for contributors (#3236)
* docs: clarify upstream remote setup and fork sync steps * docs: refine fork sync section structure * docs: apply review feedback to fork sync section * Update CONTRIBUTING.md --------- Co-authored-by: Arkadii Yakovets <arkadii.yakovets@owasp.org> Co-authored-by: Arkadii Yakovets <2201626+arkid15r@users.noreply.github.com>
1 parent e9cf300 commit bf345da

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,9 +492,40 @@ flowchart TD
492492
linkStyle 24 stroke:#f44336,stroke-width:2px
493493
```
494494
495+
### Keep Your Fork in Sync with Upstream
496+
497+
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.
498+
499+
<details>
500+
<summary>Setting up the upstream remote</summary>
501+
502+
If you haven't added the upstream remote yet, add it using:
503+
504+
```bash
505+
git remote add upstream https://github.com/OWASP/Nest.git
506+
```
507+
508+
Verify that the upstream remote has been added by running:
509+
510+
```bash
511+
git remote -v
512+
```
513+
514+
This should show both `origin` (your fork) and `upstream` (the main repository) remotes.
515+
516+
</details>
517+
518+
Before working on a **new** feature or issue, update your local `main` branch from `upstream/main`:
519+
520+
```bash
521+
git checkout main
522+
git fetch upstream
523+
git merge upstream/main
524+
```
525+
495526
### 1. Find Something to Work On
496527
497-
- Check the **Issues** tab for open issues: [https://github.com/owasp/nest/issues](https://github.com/owasp/nest/issues)
528+
- Check the **Issues** tab for open issues: [https://github.com/OWASP/Nest/issues](https://github.com/OWASP/Nest/issues)
498529
- Found a bug or have a feature request? Open a new issue.
499530
- Want to work on an existing issue? Ask the maintainers to assign it to you before submitting a pull request.
500531
- New to the project? Start with issues labeled `good first issue` for an easier onboarding experience.

0 commit comments

Comments
 (0)