1845e069e0
- Add SYSTEM_PROMPT.md with full documentation philosophy - Add STYLE_GUIDE.md with detailed writing standards - Create services/ directory with docs for API, Operator, Core, Web, Prism, Infra - Create agents/ directory with agent ecosystem documentation - Create guides/ directory with getting-started and contributing guides - Create runbooks/ directory with incident playbook and deployment runbooks - Create reference/ directory with API reference placeholder - Update sidebars.ts to include all new sections - Update CONTRIBUTING.md to reference new comprehensive guides - Update .gitignore to exclude binary assets per system prompt requirements - All documentation builds successfully with no broken links Co-authored-by: blackboxprogramming <118287761+blackboxprogramming@users.noreply.github.com>
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
---
|
|
id: guides-coding-standards
|
|
title: "Coding Standards"
|
|
slug: /guides/coding-standards
|
|
description: "Coding standards for BlackRoad OS projects"
|
|
tags: ["guides", "development", "standards"]
|
|
status: planned
|
|
---
|
|
|
|
# Coding Standards
|
|
|
|
> 📋 **Status:** This document is planned and will be developed.
|
|
|
|
Comprehensive coding standards for BlackRoad OS development.
|
|
|
|
## Overview
|
|
|
|
This document will provide:
|
|
- Language-specific coding conventions
|
|
- Best practices for TypeScript/JavaScript
|
|
- Testing requirements
|
|
- Code review guidelines
|
|
- Performance considerations
|
|
|
|
## Planned Sections
|
|
|
|
### TypeScript/JavaScript
|
|
- Naming conventions
|
|
- Type safety requirements
|
|
- Async/await patterns
|
|
- Error handling
|
|
|
|
### Testing
|
|
- Unit test requirements
|
|
- Integration test patterns
|
|
- E2E test guidelines
|
|
- Coverage expectations
|
|
|
|
### Documentation
|
|
- Code comment standards
|
|
- JSDoc requirements
|
|
- README templates
|
|
|
|
### Security
|
|
- Input validation
|
|
- Authentication patterns
|
|
- Secret management
|
|
- Dependency security
|
|
|
|
## Current Resources
|
|
|
|
For now, please refer to:
|
|
- [Contributing Guide](./contributing.md)
|
|
- [Style Guide](meta/STYLE_GUIDE.md)
|
|
- Existing code in repositories as examples
|
|
|
|
## See Also
|
|
|
|
- [Contributing Guide](./contributing.md)
|
|
- [Getting Started - Local](./getting-started-local.md)
|