-
Notifications
You must be signed in to change notification settings - Fork 4
feat: Phase 1 TODO - Enhanced Agent System #73
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
Changes from all commits
7aaed53
c1885b7
a096e65
3562ad7
733fe32
64b7e6f
37e5ec1
efd840d
34c8fff
f50d06a
835539a
1b752ee
521d774
f7768d5
abb20ba
22244c4
a789360
9048364
bb30757
131f5db
aeb8b8e
012994b
caad9b6
0d9a516
2151738
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| type: "agent_requested" | ||
| description: "Follow this exact protocol step-by-step to ensure the codebase is in excellent shape, all documentation is relevant and up-to-date, and a changelog is maintained before creating a new pull request (PR). Do not skip any steps. Report back on each step's outcome for verification." | ||
| --- | ||
| repare and Create a High-Quality Pull Request | ||
|
|
||
| Follow this exact protocol step-by-step to ensure the codebase is in excellent shape, all documentation is relevant and up-to-date, and a changelog is maintained before creating a new pull request (PR). Do not skip any steps. Report back on each step's outcome for verification. | ||
|
|
||
| Review and Optimize the Codebase: | ||
| Perform a full code review: Check for code quality, bugs, inefficiencies, and adherence to best practices (e.g., using linters like ESLint for JS or pylint for Python if applicable). | ||
| Run all tests (unit, integration, etc.) to ensure 100% pass rate. Fix any failures. | ||
| Ensure the code is modular, readable, and follows the project's style guide (e.g., PEP 8 for Python). | ||
| Remove any dead code, unused variables, or deprecated features. | ||
| Confirm the branch is up-to-date with the main branch (e.g., via git pull origin main and resolve conflicts). | ||
| Update and Prune Documentation: | ||
| Review all documentation files (e.g., README.md, API docs, user guides, inline comments). | ||
| Update any sections that are outdated features, APIs, or instructions to match the current codebase. | ||
| Remove any documentation files or sections that are no longer relevant (e.g., docs for removed features). If a file is partially irrelevant, refactor it instead of deleting. | ||
| Add new documentation where needed (e.g., for new features or changes). | ||
| Ensure docs are clear, concise, and formatted consistently (e.g., use Markdown best practices). | ||
| If the project lacks one, create or update a CHANGELOG.md file following the Keep a Changelog format. Append entries for this change under sections like "Added," "Changed," "Fixed," or "Removed," including version numbers and dates. | ||
| Stage and Commit Changes: | ||
| Stage all modified, added, or deleted files (e.g., via git add .). | ||
| Create a clean commit history: Use descriptive commit messages (e.g., "feat: Add user authentication" following Conventional Commits). Squash unnecessary commits if the history is messy. | ||
| Commit all changes with a final message summarizing the updates (e.g., "Update codebase, docs, and changelog for feature X"). | ||
| Create the Pull Request: | ||
| Push the branch to the remote repository (e.g., git push origin <branch-name>). | ||
| Create a new PR on GitHub targeting the main branch. | ||
| Use a clear, concise title (e.g., "Enhance user auth with improved security"). | ||
| In the PR description, include: | ||
| A summary of changes. | ||
| Links to related issues. | ||
| Before/after details for major updates. | ||
| Confirmation that tests pass, docs are updated, and changelog is appended. | ||
| Screenshots or examples if applicable. | ||
| Keep the PR small and focused—if changes are large, suggest splitting into multiple PRs. | ||
| Assign reviewers and add labels (e.g., "enhancement," "documentation"). | ||
| Final Verification and Reporting: | ||
| Double-check that the codebase is stable (e.g., no lint errors, all tests pass). | ||
| If any issues arise during these steps, fix them and note them in the PR description. | ||
| Output a success message with the PR URL once created. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -120,3 +120,29 @@ jobs: | |
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| files: ./artifacts/*.tar.gz | ||
|
|
||
| fmt: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Install latest stable | ||
| uses: actions-rs/toolchain@v1 | ||
| with: | ||
| toolchain: stable | ||
| override: true | ||
| components: rustfmt | ||
| - name: cargo fmt --check | ||
| run: cargo fmt --all -- --check | ||
|
|
||
|
Comment on lines
+124
to
+136
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Upgrade actions to supported versions and fail on clippy warnings. Actionlint flags actions/checkout@v3 and actions-rs/toolchain@v1 as too old. Switch to checkout@v4 and dtolnay/rust-toolchain@stable, and make clippy fail on warnings. Apply this diff to the new jobs: fmt:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
- - name: Install latest stable
- uses: actions-rs/toolchain@v1
- with:
- toolchain: stable
- override: true
- components: rustfmt
+ - uses: actions/checkout@v4
+ - name: Install latest stable
+ uses: dtolnay/rust-toolchain@stable
+ with:
+ components: rustfmt
- name: cargo fmt --check
run: cargo fmt --all -- --check
clippy:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v3
- - name: Install latest stable
- uses: actions-rs/toolchain@v1
- with:
- toolchain: stable
- override: true
- components: clippy
+ - uses: actions/checkout@v4
+ - name: Install latest stable
+ uses: dtolnay/rust-toolchain@stable
+ with:
+ components: clippy
- name: cargo clippy
- run: cargo clippy --all-targets --all-features
+ run: cargo clippy --all-targets --all-features -D warningsAlso applies to: 137-149 🧰 Tools🪛 actionlint (1.7.7)127-127: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue (action) 129-129: the runner of "actions-rs/toolchain@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue (action) 🤖 Prompt for AI Agents |
||
| clippy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Install latest stable | ||
| uses: actions-rs/toolchain@v1 | ||
| with: | ||
| toolchain: stable | ||
| override: true | ||
| components: clippy | ||
| - name: cargo clippy | ||
| run: cargo clippy --all-targets --all-features | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||||||||||||||||||||||
| repos: | ||||||||||||||||||||||||||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||||||||||||||||||||||||||
| rev: v4.6.0 | ||||||||||||||||||||||||||
| hooks: | ||||||||||||||||||||||||||
| - id: check-yaml | ||||||||||||||||||||||||||
| - id: end-of-file-fixer | ||||||||||||||||||||||||||
| - id: trailing-whitespace | ||||||||||||||||||||||||||
| - repo: local | ||||||||||||||||||||||||||
| hooks: | ||||||||||||||||||||||||||
| - id: rustfmt | ||||||||||||||||||||||||||
| name: rustfmt | ||||||||||||||||||||||||||
| entry: cargo fmt --all -- | ||||||||||||||||||||||||||
| language: system | ||||||||||||||||||||||||||
| types: [rust] | ||||||||||||||||||||||||||
| pass_filenames: false | ||||||||||||||||||||||||||
| - id: clippy | ||||||||||||||||||||||||||
| name: clippy | ||||||||||||||||||||||||||
| entry: cargo clippy --all-targets | ||||||||||||||||||||||||||
| language: system | ||||||||||||||||||||||||||
| types: [rust] | ||||||||||||||||||||||||||
| pass_filenames: false | ||||||||||||||||||||||||||
|
Comment on lines
+16
to
+21
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Ensure clippy fails on warnings and covers all features Pre-commit should block commits on new warnings. Add -D warnings and consider --all-features to match CI rigor. Apply: - - id: clippy
- name: clippy
- entry: cargo clippy --all-targets
+ - id: clippy
+ name: clippy
+ entry: cargo clippy --all-targets --all-features -- -D warnings
language: system
types: [rust]
pass_filenames: false📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||
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.
Typo in title: “repare” → “Prepare”.
This is user-facing process documentation; fix the heading.
📝 Committable suggestion
🤖 Prompt for AI Agents