Clean up#95
Open
gkostin1966 wants to merge 4 commits intoumichfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Documentation-only cleanup to generalize the repo’s “coding agent” guidance and work-tracking markdown so it supports multiple concurrent work items and standardizes plan documents under plans/.
Changes:
- Added a reusable plan template at
plans/PLAN_TEMPLATE.md. - Moved/updated the existing password-login plan into
plans/and refreshed its header metadata. - Rewrote
AGENTS.md,TODO.md,DONE.md, andPULL_REQUEST.mdinto repo-wide, feature-agnostic tracking/guidance docs.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
plans/PLAN_TEMPLATE.md |
Adds a standardized template for future feature plans. |
plans/PLAN_DSPACE_ANGULAR_PASSWORD_LOGIN.md |
Updates header metadata to reflect new location and merged status. |
AGENTS.md |
Replaces feature-specific agent notes with repo-wide guidelines and reusable patterns. |
TODO.md |
Restructures work tracking to support parallel work items. |
DONE.md |
Restructures completed-work archive format by feature/work item. |
PULL_REQUEST.md |
Updates PR template/content to match the new “clean-up” documentation focus. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Active branch | `show-password-login` | | ||
| | Base branch | `umich` / `issue-working` | | ||
| | Primary branch | `umich` | | ||
| | Framework | Angular 14 / DSpace 7.6 | |
Comment on lines
+46
to
49
| ## ✅ Task A — Generalize coding-agent markdown files | ||
|
|
||
| **Test result:** ✅ 3 specs, 0 failures | ||
| ``` | ||
| ✔ should create LogInComponent | ||
| ✔ should render a log-in container component for each auth method available | ||
| ✔ should render only the password auth method when showPasswordLogin is enabled | ||
| TOTAL: 3 SUCCESS | ||
| ``` | ||
| **Branch:** `clean-up` → merged to `umich` as **PR #___** | ||
|
|
Comment on lines
+10
to
48
| ## Task A — Generalize coding-agent markdown files | ||
|
|
||
| **Branch:** `clean-up` | ||
| **Goal:** Replace the `show-password-login`-specific agent files (`AGENTS.md`, `TODO.md`, | ||
| `DONE.md`) with general-purpose equivalents that can track multiple plans and work items | ||
| in parallel, and move plan documents into a dedicated `plans/` directory. | ||
|
|
||
| ### Subtasks (in order) | ||
|
|
||
| - [x] **A1. Create `plans/` directory** — move `PLAN_DSPACE_ANGULAR_PASSWORD_LOGIN.md` | ||
| into `plans/` so all per-feature design documents live in one place. | ||
| Update any cross-references inside the file to reflect its new path. | ||
|
|
||
| - [x] **A2. Rewrite `AGENTS.md`** — strip out all `show-password-login`-specific content | ||
| and replace with repo-wide guidance: | ||
| - Repository overview (framework, language, conventions). | ||
| - How to find work: read `TODO.md`, read the relevant `plans/` document. | ||
| - General coding guidelines (currently guideline 9 about non-interactive CLI flags — | ||
| keep and expand as the canonical list for all agents). | ||
| - Reusable codebase patterns worth knowing (e.g. `APP_CONFIG` injection, Angular | ||
| testing patterns, `By.directive` vs `CUSTOM_ELEMENTS_SCHEMA`). | ||
| - Remove all references to a specific branch, ticket, or feature. | ||
|
|
||
| - [x] **A3. Rewrite `TODO.md`** (this file) — convert to the general format illustrated | ||
| here: tasks grouped by work item, each referencing its plan document, no hardcoded | ||
| branch or feature names in the file header. | ||
|
|
||
| - [x] **A4. Rewrite `DONE.md`** — convert to a general archive grouped by work item / | ||
| feature, each group headed by the feature name and merged-PR reference rather than | ||
| a flat chronological list tied to `show-password-login`. | ||
|
|
||
| - [x] **A5. Add a `plans/PLAN_TEMPLATE.md`** — a blank plan template that a human or | ||
| agent can copy when starting a new feature, with sections for: Problem, Chosen | ||
| Solution, Key Files, Truth Table / Example Config, Verification Steps. | ||
|
|
||
| - [x] **A6. Commit all changes** on `clean-up` and open a PR against `umich`. | ||
|
|
||
| --- | ||
|
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
clean-up — Generalize coding-agent markdown files
Summary
Converts the
show-password-login-specific agent-guidance files intorepo-wide, feature-agnostic tooling that can support multiple plans and
work items running in parallel.
No source code is changed. All commits are documentation only.
Changes
PLAN_DSPACE_ANGULAR_PASSWORD_LOGIN.md→plans/PLAN_DSPACE_ANGULAR_PASSWORD_LOGIN.mdMoved the plan document into a new
plans/directory so all per-featuredesign documents live in one place. Updated the file's own header to reflect
its new path and merged status.
plans/PLAN_TEMPLATE.md(new)Blank plan template for future features. Sections: Problem, Chosen Solution,
Key Files, Exact Code Changes, Config / Environment Variables, Truth Table,
Verification Steps, Out-of-Band Tasks.
AGENTS.mdRewritten as repo-wide coding-agent guidelines. Removed all
show-password-login-specific content. Now contains:TODO.md→plans/document).get_errorsafter every TS edit, commit message convention,
ng testflags, etc.).APP_CONFIGinjection, adding a config flag,CUSTOM_ELEMENTS_SCHEMAbehaviour,TestBed.overrideProvider()limitation.TODO.mdRewritten to support multiple parallel work items. Each work item is a
top-level heading with its own subtask checklist and a reference to the
relevant plan document.
DONE.mdRewritten as a general feature archive. Each completed feature is a
top-level heading with its plan reference, branch, PR number, and a
concise summary of what was done.
Why
The previous files were written during the
show-password-loginsprint andwere tightly coupled to that feature. As the next feature work starts, a
coding agent that reads
AGENTS.md/TODO.mdwould be confused byfeature-specific instructions. This PR makes the system self-consistent and
ready for the next task.