Skip to content

Commit 6ce5093

Browse files
committed
Update contribution guide to emphasize iloom workflow context. Fixes #394
- Add note about creating PRs with iloom for automatic context generation - Change default mode to github-draft-pr for immediate PR creation - Document that iloom posts AI analysis and implementation plan to PRs - Clarify manual PR requirements if not using iloom - Update CONTRIBUTING.md and README.md with context requirements
1 parent 858dee4 commit 6ce5093

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Thank you for your interest in contributing to iloom! This guide will help you g
44

55
We welcome all types of contributions and are committed to making the contribution process as smooth and transparent as possible. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
66

7+
> **Important:** All pull requests should be created with iloom or include detailed context about the changes. When you run `iloom contribute` (or use the manual setup below), iloom is configured to create a draft PR as soon as you start work on an issue. As you work, iloom posts the AI's analysis, implementation plan, and progress directly to that draft PR as comments—giving reviewers full context before the code is even ready for review. If you're not using iloom, please provide equivalent detail about your changes and the reasoning behind them.
8+
79
## Quick Start with `iloom contribute`
810

911
The fastest way to get started as a contributor is using the automated setup command:
@@ -16,7 +18,7 @@ This command automates the entire contributor onboarding process:
1618
- Creates a fork of the iloom-cli repository (if you don't have one)
1719
- Clones your fork to your local machine
1820
- Configures the upstream remote to track the main repository
19-
- Sets up contributor-specific settings (github-pr mode for pull request workflow)
21+
- Sets up contributor-specific settings (github-draft-pr mode for pull request workflow)
2022

2123
**Next steps after running `iloom contribute`:**
2224
1. `cd` into the cloned directory
@@ -63,7 +65,12 @@ If you prefer manual setup or already have a fork:
6365
```bash
6466
pnpm install
6567
```
66-
5. **Configure iloom settings** by creating `.iloom/settings.local.json`:
68+
5. **Configure iloom settings** using the interactive wizard:
69+
```bash
70+
il init "configure for contributing with upstream remote and github-draft-pr mode"
71+
```
72+
73+
Or manually create `.iloom/settings.local.json`:
6774
```json
6875
{
6976
"issueManagement": {
@@ -72,7 +79,7 @@ If you prefer manual setup or already have a fork:
7279
}
7380
},
7481
"mergeBehavior": {
75-
"mode": "github-pr"
82+
"mode": "github-draft-pr"
7683
}
7784
}
7885
```
@@ -182,11 +189,11 @@ iloom finish
182189
This command:
183190
- Validates your changes (typecheck, lint, test)
184191
- Offers AI-assisted error fixing if validation fails
185-
- Creates a pull request automatically (in `github-pr` mode)
192+
- Creates a pull request automatically (in `github-draft-pr` mode)
186193
- Runs the complete merge workflow
187194
- Cleans up the workspace when done
188195

189-
For contributors, the `github-pr` mode (configured by `iloom contribute`) will create a pull request to the upstream repository rather than attempting a direct merge.
196+
For contributors, the `github-draft-pr` mode (configured by `iloom contribute`) creates a draft pull request immediately when starting work, which becomes ready for review when you run `iloom finish`. Throughout the iloom workflow, detailed comments are automatically added to the draft PR documenting the analysis, implementation plan, and progress—providing reviewers with rich context about the changes.
190197

191198
## Pull Request Process
192199

@@ -196,13 +203,15 @@ If using `iloom finish`, the PR is created automatically with:
196203
- Issue reference in title
197204
- Implementation summary in description
198205
- Link to related issue
206+
- Detailed workflow comments (analysis, planning, implementation notes)
199207

200-
If creating manually, ensure your PR:
208+
If creating manually, you'll need to provide the context that iloom would normally generate. Ensure your PR:
201209
- Has a clear, descriptive title
202210
- References the issue number (e.g., "Fixes #123")
203-
- Includes a summary of changes
211+
- Includes a detailed summary of changes and the reasoning behind them
204212
- Describes any breaking changes
205213
- Documents testing performed
214+
- Explains the implementation approach (why this solution vs. alternatives)
206215

207216
### Review Process
208217

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -355,6 +355,8 @@ We (Claude and I) welcome contributions! We've made it easy to get started — i
355355
iloom contribute # Handles forking, cloning, and setting up the dev environment automatically.
356356
```
357357

358+
**All PRs should be created with iloom or include detailed context.** When you run `iloom contribute`, it configures iloom to create a draft PR as soon as you start work. As you work, iloom posts the AI's analysis, implementation plan, and progress directly to that draft PR—giving reviewers full context before the code is even ready for review. If you're not using iloom, please provide equivalent detail in your PR.
359+
358360
New contributors should start with issues labeled [starter-task](https://github.com/iloom-ai/iloom-cli/issues?q=is%3Aissue+is%3Aopen+label%3Astarter-task). For details, see our [Contributing Guide](CONTRIBUTING.md).
359361

360362
License & Name

src/commands/contribute.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ export class ContributeCommand {
320320
},
321321
},
322322
mergeBehavior: {
323-
mode: 'github-pr',
323+
mode: 'github-draft-pr',
324324
},
325325
}
326326

0 commit comments

Comments
 (0)