50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# Global Steering Document
|
|
|
|
This document provides overarching guidelines for all projects within MyWorkspace.
|
|
|
|
## Project Organization
|
|
|
|
- Each project should be in its own subfolder within MyWorkspace
|
|
- Every project folder should contain its own `STEERING.md` with project-specific guidelines
|
|
- Project folders may include a `README.md` for project-specific documentation
|
|
|
|
## Development Practices
|
|
|
|
### General Guidelines
|
|
- Follow clean code principles: write readable, maintainable, and well-documented code
|
|
- Use meaningful variable and function names
|
|
- Keep functions focused on a single responsibility
|
|
- Write comments that explain *why*, not *what*
|
|
|
|
### Version Control
|
|
- Use meaningful commit messages
|
|
- Create feature branches for new work
|
|
- Review code before merging
|
|
|
|
### Testing
|
|
- Write tests for new functionality
|
|
- Ensure existing tests pass before merging
|
|
- Aim for meaningful test coverage
|
|
|
|
### Documentation
|
|
- Document new features and APIs
|
|
- Keep documentation updated with code changes
|
|
- Include setup instructions in project README files
|
|
|
|
## Technology Guidelines
|
|
|
|
- Use stable, well-supported technology versions
|
|
- Keep dependencies up to date
|
|
- Prefer established libraries over custom solutions when appropriate
|
|
- Consider security implications of dependencies
|
|
|
|
## Communication
|
|
|
|
- Document decisions in project notes or wikis
|
|
- Update relevant documentation when making significant changes
|
|
- Coordinate across projects to avoid conflicts
|
|
|
|
---
|
|
|
|
*For project-specific steering, refer to the STEERING.md in each project folder.*
|