Skip to content

Commit 3637a70

Browse files
TonyCappidsterCopilot
authored
Docs/migrate contributing guide to be fork based (#14)
* docs: Migrate contributing guide to be focused on a fork based workflow instead of creating a branch in the original repo. * docs: Be more precise in the PR creation description in the contributing guide. * docs: Resolve Markdown linting errors in contribution guide: blank lines surrounding fenced code blocks. * Update CONTRIBUTING.md Co-authored-by: Copilot <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Stuart Williams <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 8d7f250 commit 3637a70

File tree

1 file changed

+43
-8
lines changed

1 file changed

+43
-8
lines changed

CONTRIBUTING.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,23 @@ For minor fixes (typos, small corrections):
9595

9696
### 3. Development Workflow
9797

98-
Follow the repository's trunk-based development workflow:
98+
#### Fork the Repository
9999

100-
#### Branch Creation
100+
1. **Fork**: Click the "Fork" button on GitHub to create your own copy of the repository
101+
2. **Clone your fork**:
102+
103+
```bash
104+
git clone https://github.com/YOUR-USERNAME/template-github-copilot.git
105+
cd template-github-copilot
106+
```
107+
108+
3. **Add upstream remote** (to keep your fork synchronized with the original repository):
109+
110+
```bash
111+
git remote add upstream https://github.com/Capgemini/template-github-copilot.git
112+
```
113+
114+
#### Create a Feature Branch
101115

102116
Create a feature branch following our naming conventions:
103117

@@ -170,12 +184,33 @@ non-negotiable requirements while maintaining human readability
170184
-->
171185
```
172186

173-
### 4. Submit a Pull Request
187+
### 4. Keep Your Fork Updated
188+
189+
Before submitting your pull request, sync your fork with the latest changes:
190+
191+
```bash
192+
git fetch upstream
193+
git checkout main
194+
git merge upstream/main
195+
git push origin main
196+
```
197+
198+
Then rebase your feature branch:
199+
200+
```bash
201+
git checkout <type>/<brief-description>
202+
git rebase main
203+
```
204+
205+
### 5. Submit a Pull Request
174206

175-
1. **Push your branch**: `git push origin <type>/<brief-description>`
176-
2. **Create PR**: Open a pull request with a clear title matching your branch name format
177-
3. **Complete PR template**: Fill out all sections of the pull request template
178-
4. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456`
207+
1. **Push your branch to your fork**: `git push origin <type>/<brief-description>`
208+
2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request"
209+
(Your fork repository should also detect the changes and offer a button `Compare & pull request`)
210+
3. **Select branches**: Choose your fork's branch as the source (set `head` repository to your fork, `compare` branch to your feature branch)
211+
and the original repository's `main` as the target (set `base` repository to `Capgemini/template-github-copilot`, `base` branch to `main`)
212+
4. **Complete PR template**: Fill out all sections of the pull request template
213+
5. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456`
179214

180215
#### Pull Request Requirements
181216

@@ -188,7 +223,7 @@ Your PR must include:
188223
- **Thorough comments**: All prompt content must be well-commented
189224
- **Small scope**: Keep PRs focused (target ≤ 400 lines when possible)
190225

191-
### 5. Review Process
226+
### 6. Review Process
192227

193228
1. **Automated checks**: Ensure all CI checks pass (markdown lint, link checker, etc.)
194229
2. **Maintainer review**: At least one maintainer approval required

0 commit comments

Comments
 (0)