You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-7Lines changed: 16 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ Thank you for your interest in contributing to iloom! This guide will help you g
4
4
5
5
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).
6
6
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
+
7
9
## Quick Start with `iloom contribute`
8
10
9
11
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:
16
18
- Creates a fork of the iloom-cli repository (if you don't have one)
17
19
- Clones your fork to your local machine
18
20
- 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)
20
22
21
23
**Next steps after running `iloom contribute`:**
22
24
1.`cd` into the cloned directory
@@ -63,7 +65,12 @@ If you prefer manual setup or already have a fork:
63
65
```bash
64
66
pnpm install
65
67
```
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`:
67
74
```json
68
75
{
69
76
"issueManagement": {
@@ -72,7 +79,7 @@ If you prefer manual setup or already have a fork:
72
79
}
73
80
},
74
81
"mergeBehavior": {
75
-
"mode": "github-pr"
82
+
"mode": "github-draft-pr"
76
83
}
77
84
}
78
85
```
@@ -182,11 +189,11 @@ iloom finish
182
189
This command:
183
190
- Validates your changes (typecheck, lint, test)
184
191
- 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)
186
193
- Runs the complete merge workflow
187
194
- Cleans up the workspace when done
188
195
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.
190
197
191
198
## Pull Request Process
192
199
@@ -196,13 +203,15 @@ If using `iloom finish`, the PR is created automatically with:
Copy file name to clipboardExpand all lines: README.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -355,6 +355,8 @@ We (Claude and I) welcome contributions! We've made it easy to get started — i
355
355
iloom contribute # Handles forking, cloning, and setting up the dev environment automatically.
356
356
```
357
357
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
+
358
360
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).
0 commit comments