-
Notifications
You must be signed in to change notification settings - Fork 119
AGENTS: Add first version #3715
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
Conversation
Reviewer's GuideIntroduces AGENTS.md, a high-level instruction document defining how AI agents should behave and work within the BlueOS repository, including persona, project context, development conventions, and critical rules for dependencies, services, and code quality. Flow diagram for creating a new BlueOS service (flow diagram)flowchart TD
A[Start: Need a new service] --> B[Define service purpose in one sentence]
B --> C[Identify most similar existing service
copy its structure]
C --> D[Check core/tools/nginx/nginx.conf
select unused port]
D --> E[Check core/pyproject.toml
use existing dependencies only]
E --> F[Implement service inside core/services
following existing patterns]
F --> G[Register service in core/pyproject.toml]
G --> H[Register service in start-blueos-core]
H --> I[Update core/tools/nginx/nginx.conf
with new route]
I --> J[Run .hooks/pre-push --fix]
J --> K[All checks pass?]
K -->|No| F
K -->|Yes| L[Open PR for review]
L --> M[End]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey - I've left some high level feedback:
- The fixed dependency version list in 'Critical Rules' may drift from core/pyproject.toml over time; consider instead pointing explicitly to that file as the single source of truth rather than duplicating the versions here.
- Some guidance (e.g., using gh, running ./.hooks/pre-push) is generally applicable to contributors beyond AI agents; consider clarifying the intended audience at the top or factoring shared contributor guidance into a common location to avoid divergence.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The fixed dependency version list in 'Critical Rules' may drift from core/pyproject.toml over time; consider instead pointing explicitly to that file as the single source of truth rather than duplicating the versions here.
- Some guidance (e.g., using gh, running ./.hooks/pre-push) is generally applicable to contributors beyond AI agents; consider clarifying the intended audience at the top or factoring shared contributor guidance into a common location to avoid divergence.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
4f579bd to
4fb8291
Compare
Signed-off-by: Patrick José Pereira <[email protected]>
4fb8291 to
03d932c
Compare
Summary by Sourcery
Documentation: