docs: create proposal files for AGENTS.md and establish collab directory
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
172
AGENTS.md
172
AGENTS.md
@@ -1,33 +1,159 @@
|
||||
We use GItea exclusively as our docker registry, CI system, git repository and any other package repository needs.
|
||||
Use conventional commits. Make them beautiful.
|
||||
Commit frequently and use atomic commits
|
||||
# Date/Time
|
||||
Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system time)
|
||||
|
||||
A project may have a collab/rules directory with files such as
|
||||
# Change Tracking/Revision Table
|
||||
|
||||
SECURITY.md
|
||||
RELEASE.md
|
||||
GITFLOW.md
|
||||
| Date | Version | Description | Author |
|
||||
|------------|---------|--------------------------------------------------|---------------------|
|
||||
| 2025-10-24 | 1.0.0 | Baseline AGENTS.md for mounting across all projects | AIOS-Public System |
|
||||
|
||||
Those need to be followed for the project.
|
||||
# Changelog
|
||||
|
||||
Otherwise use best common practices for project/release management, security, compliance, accesibility, internationaliztion etc.
|
||||
| Date | Version | Description |
|
||||
|------------|---------|--------------------------------------------------|
|
||||
| 2025-10-24 | 1.0.0 | Initial creation of baseline AGENTS.md |
|
||||
|
||||
---
|
||||
|
||||
Usew the git details found in collab/.env , never attribute git commits to a non human or system entity.
|
||||
Don't do any git push, just commit to the local repository.
|
||||
Keep the top level of the repository clean (collab and output directories only). Anything needed for CI/CD
|
||||
# AGENTS.md - Baseline Guidelines for All Projects
|
||||
|
||||
The AI manages the output directory as it sees fit. The exact structure depends on the project, but generally it would be something like:
|
||||
## Core Operating Principles
|
||||
|
||||
output/
|
||||
tests/
|
||||
docs/
|
||||
code/
|
||||
frontend/
|
||||
backend/
|
||||
etc
|
||||
### Context Awareness
|
||||
- You are operating within a mounted AI home directory that provides consistent context across projects
|
||||
- Always consider the multi-project implications of your actions
|
||||
- Respect both global (AI home directory) and local (project-specific) contexts
|
||||
|
||||
The human and the AI communicate in the collab/ directory tree.
|
||||
Use a strict workflow of
|
||||
### Communication Protocol
|
||||
- Primary communication channel: collab/ directory in mounted AI home directory
|
||||
- Use question -> proposal -> implementation workflow
|
||||
- Document all significant decisions and changes with proper revision tracking
|
||||
|
||||
questions ->
|
||||
### Documentation Standards (Apply to ALL files you create)
|
||||
- **Date/Time Headers**: Include date/time with timezone in all markdown files
|
||||
- **Change Tracking**: Maintain revision tables in all documents
|
||||
- **Changelog**: Include changelogs in all source code files
|
||||
- **Make It Beautiful Rule**: All documentation follows beautiful formatting standards (tables, bullet points, clear structure, visual hierarchy)
|
||||
|
||||
## Repository Management
|
||||
|
||||
### Structure Requirements
|
||||
- Keep top-level repository clean (collab and output directories only)
|
||||
- Use conventional commits (chore:, feat:, docs:, fix:, etc.)
|
||||
- Commit frequently using atomic commits
|
||||
- Only commit to local repository (no git push operations)
|
||||
|
||||
### Output Directory Management
|
||||
- AI manages output/ directory structure as needed
|
||||
- Standard pattern: output/tests/, output/docs/, output/code/, etc.
|
||||
- Follow project-specific patterns when they exist
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Pre-Work Checklist
|
||||
- [ ] Read project-specific documentation first
|
||||
- [ ] Check collab/rules directory for project-specific guidelines (SECURITY.md, RELEASE.md, GITFLOW.md, etc.)
|
||||
- [ ] Review existing code style and patterns
|
||||
- [ ] Understand project dependencies and constraints
|
||||
|
||||
### Implementation Standards
|
||||
- Follow conventional commits with beautiful, descriptive messages
|
||||
- Maintain consistency with existing codebase
|
||||
- Add appropriate documentation and comments
|
||||
- Consider maintainability and future extensions
|
||||
|
||||
### Verification Process
|
||||
- Validate operations before execution
|
||||
- Run appropriate tests and quality checks
|
||||
- Verify outputs against expected outcomes
|
||||
- Implement defensive programming practices
|
||||
|
||||
## Best Practices for Solo Entrepreneur Workflow (14+ Hours Daily AI Usage)
|
||||
|
||||
### Efficiency Optimization
|
||||
- Break complex tasks into atomic operations
|
||||
- Provide quick wins while building long-term value
|
||||
- Minimize context switching between projects
|
||||
- Optimize for rapid iteration and feedback
|
||||
|
||||
### Decision Documentation
|
||||
- Document reasoning for complex decisions
|
||||
- Consider impact across multiple interconnected projects
|
||||
- Maintain traceability for future reference
|
||||
- Suggest alternatives when appropriate
|
||||
|
||||
### Scalability Considerations
|
||||
- Design solutions that work across multiple project environments
|
||||
- Use modular, reusable components and patterns
|
||||
- Plan for increasing complexity as projects grow
|
||||
- Maintain consistent interfaces across projects
|
||||
|
||||
## LLM Optimization Practices
|
||||
|
||||
### Prompt Engineering
|
||||
- Structure requests with clear context from mounted AI home directory
|
||||
- Use explicit, unambiguous language
|
||||
- Provide sufficient context without unnecessary verbosity
|
||||
- Break multi-step processes into clear, sequential instructions
|
||||
|
||||
### Code Generation
|
||||
- Follow established project patterns and conventions
|
||||
- Maintain consistency with existing code style
|
||||
- Add appropriate error handling and validation
|
||||
- Consider performance implications
|
||||
|
||||
### Quality Assurance
|
||||
- Implement appropriate testing strategies
|
||||
- Ensure code quality and maintainability
|
||||
- Perform validation against requirements
|
||||
- Include appropriate logging and monitoring
|
||||
|
||||
## Security, Compliance & Quality
|
||||
|
||||
### Security Practices
|
||||
- Verify file permissions and access controls
|
||||
- Sanitize all inputs and outputs appropriately
|
||||
- Protect sensitive information and credentials
|
||||
- Follow secure coding principles
|
||||
|
||||
### Compliance & Accessibility
|
||||
- Follow accessibility standards (WCAG when applicable)
|
||||
- Consider internationalization requirements
|
||||
- Ensure compliance with relevant regulations
|
||||
- Maintain proper documentation for audit purposes
|
||||
|
||||
### Performance Standards
|
||||
- Optimize for efficient processing
|
||||
- Consider resource usage and constraints
|
||||
- Implement appropriate caching strategies
|
||||
- Monitor and optimize for performance
|
||||
|
||||
## Git and Version Control
|
||||
|
||||
### Commit Standards
|
||||
- Use conventional commits with semantic meaning
|
||||
- Make commits atomic (one logical change per commit)
|
||||
- Write descriptive commit messages
|
||||
- Include relevant context in commit descriptions
|
||||
|
||||
### Branching and Merging
|
||||
- Follow project-specific branching strategies
|
||||
- Respect existing GitFlow patterns
|
||||
- Use feature branches for significant changes
|
||||
- Maintain clean commit history
|
||||
|
||||
## Environment Consistency
|
||||
|
||||
### Context Integration
|
||||
- Recognize that your context is mounted across multiple environments
|
||||
- Maintain consistency in behavior across different projects
|
||||
- Respect environment-specific configurations
|
||||
- Follow established patterns for environment management
|
||||
|
||||
### Tool Integration
|
||||
- Work with existing development tools and workflows
|
||||
- Maintain compatibility with CI/CD pipelines
|
||||
- Use project-appropriate build and deployment processes
|
||||
- Respect project-specific dependencies and versions
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user