generated from amazon-archives/__template_MIT-0
-
Notifications
You must be signed in to change notification settings - Fork 168
Add Multi-User Parallel Development Support to AI-DLC #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
jschwellach
wants to merge
1
commit into
awslabs:main
Choose a base branch
from
jschwellach:feature/multi-user
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # AGENTS.md - Project Configuration | ||
|
|
||
| Copy to project root as `AGENTS.md` to customize multi-user behavior. | ||
|
|
||
| ## Folder Structure | ||
|
|
||
| ### Generated Code | ||
| ``` | ||
| [unit-name]/ | ||
| βββ src/ # Source code (language-specific structure) | ||
| βββ tests/ # Tests | ||
| βββ docs/ # Documentation | ||
| ``` | ||
|
|
||
| ### Audits | ||
| ``` | ||
| aidlc-docs/audits/[unit-name]/[developer]/ | ||
| ``` | ||
|
|
||
| ### Branches | ||
| ``` | ||
| feature/[unit-name]-[developer] | ||
| ``` | ||
|
|
||
| ## Custom Paths (Optional) | ||
|
|
||
| Override defaults by specifying: | ||
| - `code_root`: Base path for generated code (default: `[unit-name]/`) | ||
| - `audit_root`: Base path for audits (default: `aidlc-docs/audits/`) | ||
| - `branch_prefix`: Branch naming prefix (default: `feature/`) |
jschwellach marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| # AI-DLC Multi-User Quick Reference | ||
|
|
||
| ## π Quick Start | ||
|
|
||
| ### Lead Developer | ||
| ```bash | ||
| kiro-cli chat "Create [your project description]" | ||
| # Complete inception β Choose Option B | ||
| ``` | ||
|
|
||
| ### Team Members | ||
| ```bash | ||
| git pull origin main | ||
| kiro-cli chat "claim unit <unit-name>" | ||
| # Work on unit β Complete | ||
| kiro-cli chat "complete unit <unit-name>" | ||
| ``` | ||
|
|
||
| ### Integrator | ||
| ```bash | ||
| kiro-cli chat "consolidate units" | ||
| ``` | ||
|
|
||
| ## π Commands | ||
|
|
||
| | Command | What It Does | | ||
| |---------|--------------| | ||
| | `list units` | Show all units and status | | ||
| | `claim unit <name>` | Start working on a unit | | ||
| | `complete unit <name>` | Finish your unit | | ||
| | `merge unit <name>` | Merge unit to main | | ||
| | `consolidate units` | Merge all units | | ||
| | `unit status <name>` | Check unit details | | ||
| | `show audit` | Your activity log | | ||
| | `show all audits` | Team activity logs | | ||
|
|
||
| ## π³ Branch Structure | ||
|
|
||
| ``` | ||
| main # Shared inception artifacts | ||
| βββ unit/user-service-alice # Alice's work | ||
| βββ unit/auth-service-bob # Bob's work | ||
| βββ unit/api-gateway-charlie # Charlie's work | ||
| ``` | ||
|
|
||
| ## π File Structure | ||
|
|
||
| ``` | ||
| aidlc-docs/ | ||
| βββ audit/ | ||
| β βββ user-alice-audit.md # Alice's log | ||
| β βββ user-bob-audit.md # Bob's log | ||
| β βββ audit-index.md # All logs | ||
| βββ construction/ | ||
| β βββ unit-assignments.md # Who's doing what | ||
| β βββ consolidated-index.md # Merged units | ||
| ``` | ||
|
|
||
| ## π Workflow | ||
|
|
||
| ``` | ||
| Inception (Lead) β Units Generated | ||
| β | ||
| βββββββββββββββββΌββββββββββββββββ | ||
| β β β | ||
| Alice (Unit 1) Bob (Unit 2) Charlie (Unit 3) | ||
| β β β | ||
| Complete Complete Complete | ||
| βββββββββββββββββΌββββββββββββββββ | ||
| β | ||
| Consolidate | ||
| β | ||
| Build & Test | ||
| ``` | ||
|
|
||
| ## β Status Icons | ||
|
|
||
| - β Completed | ||
| - π In Progress | ||
| - β Available | ||
| - β³ Blocked (waiting on dependency) | ||
|
|
||
| ## π― Best Practices | ||
|
|
||
| 1. **Check dependencies** before claiming units | ||
| 2. **Commit often** in your unit branch | ||
| 3. **Complete units** when all stages done | ||
| 4. **Consolidate regularly** to avoid drift | ||
| 5. **Review audits** for team coordination | ||
|
|
||
| ## π Quick Fixes | ||
|
|
||
| **Branch exists?** | ||
| ```bash | ||
| git branch -D unit/name-user | ||
| kiro-cli chat "claim unit name" | ||
| ``` | ||
|
|
||
| **Out of sync?** | ||
| ```bash | ||
| git pull origin main | ||
| kiro-cli chat "list units" | ||
| ``` | ||
|
|
||
| **Check status?** | ||
| ```bash | ||
| kiro-cli chat "unit status <name>" | ||
| ``` | ||
|
|
||
| ## π Need Help? | ||
|
|
||
| ```bash | ||
| kiro-cli chat "show all audits" # See what everyone did | ||
| kiro-cli chat "list units" # See current status | ||
| cat aidlc-docs/construction/unit-assignments.md | ||
| ``` | ||
|
|
||
| ## π Example Session | ||
|
|
||
| ```bash | ||
| # Alice starts project | ||
| kiro-cli chat "Create e-commerce API" | ||
| # β Completes inception, enables team | ||
|
|
||
| # Bob joins | ||
| git pull origin main | ||
| kiro-cli chat "claim unit product-catalog" | ||
| # β Works on unit | ||
| kiro-cli chat "complete unit product-catalog" | ||
|
|
||
| # Charlie joins | ||
| git pull origin main | ||
| kiro-cli chat "claim unit shopping-cart" | ||
| # β Works on unit | ||
| kiro-cli chat "complete unit shopping-cart" | ||
|
|
||
| # Alice consolidates | ||
| kiro-cli chat "consolidate units" | ||
| # β All units merged, build & test starts | ||
| ``` | ||
|
|
||
| ## π‘ Pro Tips | ||
|
|
||
| - Use `kiro-cli chat "I want to work on X"` instead of `claim unit X` | ||
| - Use `kiro-cli chat "I'm done with X"` instead of `complete unit X` | ||
| - Use `kiro-cli chat "what's available?"` instead of `list units` | ||
| - AI understands natural language! | ||
|
|
||
| --- | ||
|
|
||
| **Full Guide**: See `MULTI-USER-GUIDE.md` | ||
| **Implementation Details**: See `MULTI-USER-IMPLEMENTATION.md` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AGENTS.md will surely give us tool independence, but can we think about moving the entire AI-DLC steering as part of AGENTS.md as a separate feature? I think we also discussed there are other issues around AGENTS.md that if the user already has an AGENTS.md then how this will be merged into their existing file,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will raise an issue that we will use as a guiding principle for this work.
We need to adhere to the current rule mechanism and not introduce new concepts (AUDIT etc) as a part of this.
Also for this feature PR lets just work out of a branch and not use the fork mechanism.
The code needs to be rebased before raising a PR.
Please have a look at file specific comments @raj-jain-aws
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just an example configuration file, that is not necessary, as you see it has .example as ending. However if you want to control the folder structure of the multi-user feature, it is necessary to configure them somewhere. I don't want the users to mess about with the core rules so the ideal file for this is AGENTS.md as it's read automatically by the ai-assistant and such can contain global variables.