From 0a5e0e79e442a74d46a3a3a3c7ba0de679f92ccf Mon Sep 17 00:00:00 2001 From: Tony Schwedek Date: Thu, 27 Nov 2025 12:15:42 +0100 Subject: [PATCH 1/5] docs: Migrate contributing guide to be focused on a fork based workflow instead of creating a branch in the original repo. --- CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d216ac..ee74f9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,9 +94,20 @@ For minor fixes (typos, small corrections): ### 3. Development Workflow -Follow the repository's trunk-based development workflow: +#### Fork the Repository -#### Branch Creation +1. **Fork**: Click the "Fork" button on GitHub to create your own copy of the repository +2. **Clone your fork**: + ```bash + git clone https://github.com/YOUR-USERNAME/template-github-copilot.git + cd template-github-copilot + ``` +3. **Add upstream remote** (to keep your fork synchronized with the original repository): + ```bash + git remote add upstream https://github.com/Capgemini/template-github-copilot.git + ``` + +#### Create a Feature Branch Create a feature branch following our naming conventions: @@ -169,12 +180,31 @@ non-negotiable requirements while maintaining human readability --> ``` -### 4. Submit a Pull Request +### 4. Keep Your Fork Updated + +Before submitting your pull request, sync your fork with the latest changes: + +```bash +git fetch upstream +git checkout main +git merge upstream/main +git push origin main +``` + +Then rebase your feature branch: + +```bash +git checkout / +git rebase main +``` + +### 5. Submit a Pull Request -1. **Push your branch**: `git push origin /` -2. **Create PR**: Open a pull request with a clear title matching your branch name format -3. **Complete PR template**: Fill out all sections of the pull request template -4. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456` +1. **Push your branch to your fork**: `git push origin /` +2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request" +3. **Select branches**: Choose your fork's branch as the source and the original repository's `main` as the target +4. **Complete PR template**: Fill out all sections of the pull request template +5. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456` #### Pull Request Requirements @@ -187,7 +217,7 @@ Your PR must include: - **Thorough comments**: All prompt content must be well-commented - **Small scope**: Keep PRs focused (target ≤ 400 lines when possible) -### 5. Review Process +### 6. Review Process 1. **Automated checks**: Ensure all CI checks pass (markdown lint, link checker, etc.) 2. **Maintainer review**: At least one maintainer approval required From 56a5eb3af9e94d5efb147602e5d279fc9ccd72d2 Mon Sep 17 00:00:00 2001 From: Tony Schwedek Date: Thu, 27 Nov 2025 13:06:03 +0100 Subject: [PATCH 2/5] docs: Be more precise in the PR creation description in the contributing guide. --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee74f9c..0ea7b66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -201,8 +201,10 @@ git rebase main ### 5. Submit a Pull Request 1. **Push your branch to your fork**: `git push origin /` -2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request" -3. **Select branches**: Choose your fork's branch as the source and the original repository's `main` as the target +2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request". +Your fork repository should also detect the changes and offer a button `Compare & pull request` +3. **Select branches**: Choose your fork's branch as the source (`head` repository, `compare` branch) +and the original repository's `main` as the target (`base` repository and branch) 4. **Complete PR template**: Fill out all sections of the pull request template 5. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456` From 06c896cd338df8dbe762d76ff45657d9a7e76890 Mon Sep 17 00:00:00 2001 From: Tony Schwedek Date: Thu, 27 Nov 2025 13:16:34 +0100 Subject: [PATCH 3/5] docs: Resolve Markdown linting errors in contribution guide: blank lines surrounding fenced code blocks. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ea7b66..e5ba0cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,11 +98,14 @@ For minor fixes (typos, small corrections): 1. **Fork**: Click the "Fork" button on GitHub to create your own copy of the repository 2. **Clone your fork**: + ```bash git clone https://github.com/YOUR-USERNAME/template-github-copilot.git cd template-github-copilot ``` + 3. **Add upstream remote** (to keep your fork synchronized with the original repository): + ```bash git remote add upstream https://github.com/Capgemini/template-github-copilot.git ``` From 637ae1900788bed917dffef983ad0c059c34bd74 Mon Sep 17 00:00:00 2001 From: Stuart Williams Date: Mon, 1 Dec 2025 14:01:03 +0000 Subject: [PATCH 4/5] Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5ba0cb..266a990 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -204,8 +204,8 @@ git rebase main ### 5. Submit a Pull Request 1. **Push your branch to your fork**: `git push origin /` -2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request". -Your fork repository should also detect the changes and offer a button `Compare & pull request` +2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request" + (Your fork repository should also detect the changes and offer a button `Compare & pull request`) 3. **Select branches**: Choose your fork's branch as the source (`head` repository, `compare` branch) and the original repository's `main` as the target (`base` repository and branch) 4. **Complete PR template**: Fill out all sections of the pull request template From f7deef6b95694c9bee4c62a656b40c2980c1c20d Mon Sep 17 00:00:00 2001 From: Stuart Williams Date: Mon, 1 Dec 2025 14:01:43 +0000 Subject: [PATCH 5/5] Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 266a990..7f69073 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -206,8 +206,8 @@ git rebase main 1. **Push your branch to your fork**: `git push origin /` 2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request" (Your fork repository should also detect the changes and offer a button `Compare & pull request`) -3. **Select branches**: Choose your fork's branch as the source (`head` repository, `compare` branch) -and the original repository's `main` as the target (`base` repository and branch) +3. **Select branches**: Choose your fork's branch as the source (set `head` repository to your fork, `compare` branch to your feature branch) + and the original repository's `main` as the target (set `base` repository to `Capgemini/template-github-copilot`, `base` branch to `main`) 4. **Complete PR template**: Fill out all sections of the pull request template 5. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456`