Skip to content

Commit 0a5e0e7

Browse files
committed
docs: Migrate contributing guide to be focused on a fork based workflow instead of creating a branch in the original repo.
1 parent d9dd090 commit 0a5e0e7

1 file changed

Lines changed: 38 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,20 @@ For minor fixes (typos, small corrections):
9494

9595
### 3. Development Workflow
9696

97-
Follow the repository's trunk-based development workflow:
97+
#### Fork the Repository
9898

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

101112
Create a feature branch following our naming conventions:
102113

@@ -169,12 +180,31 @@ non-negotiable requirements while maintaining human readability
169180
-->
170181
```
171182

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

174-
1. **Push your branch**: `git push origin <type>/<brief-description>`
175-
2. **Create PR**: Open a pull request with a clear title matching your branch name format
176-
3. **Complete PR template**: Fill out all sections of the pull request template
177-
4. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456`
203+
1. **Push your branch to your fork**: `git push origin <type>/<brief-description>`
204+
2. **Create PR**: Go to the original repository on GitHub and click "New Pull Request"
205+
3. **Select branches**: Choose your fork's branch as the source and the original repository's `main` as the target
206+
4. **Complete PR template**: Fill out all sections of the pull request template
207+
5. **Link issues**: Reference any related issues using `Fixes #123` or `Closes #456`
178208

179209
#### Pull Request Requirements
180210

@@ -187,7 +217,7 @@ Your PR must include:
187217
- **Thorough comments**: All prompt content must be well-commented
188218
- **Small scope**: Keep PRs focused (target ≤ 400 lines when possible)
189219

190-
### 5. Review Process
220+
### 6. Review Process
191221

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

0 commit comments

Comments
 (0)