Initial commit

This commit is contained in:
Zhongwei Li
2025-11-30 08:46:53 +08:00
commit 5efae030be
12 changed files with 1857 additions and 0 deletions

View File

@@ -0,0 +1,74 @@
# ADR-{number}: {Short title of solved problem and solution}
Date: {YYYY-MM-DD}
Status: {Proposed | Accepted | Deprecated | Superseded}
Deciders: {List everyone involved in the decision}
Related: {Links to related ADRs, Oracle entries, Summoner MCDs}
## Context and Problem Statement
{Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.}
## Decision Drivers
* {decision driver 1, e.g., a force, facing concern, ...}
* {decision driver 2, e.g., a force, facing concern, ...}
* {etc.}
## Considered Options
* {option 1}
* {option 2}
* {option 3}
* {etc.}
## Decision Outcome
Chosen option: "{option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | ... | comes out best (see below)}.
### Positive Consequences
* {e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...}
* {etc.}
### Negative Consequences
* {e.g., compromising quality attribute, follow-up decisions required, ...}
* {etc.}
## Pros and Cons of the Options
### {option 1}
{example | description | pointer to more information | ...}
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* {etc.}
### {option 2}
{example | description | pointer to more information | ...}
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* {etc.}
### {option 3}
{example | description | pointer to more information | ...}
* Good, because {argument a}
* Good, because {argument b}
* Bad, because {argument c}
* {etc.}
## Links
* {Link to related Oracle knowledge entries}
* {Link to Summoner Mission Control Documents}
* {Link to code references}
* {Link to related ADRs}
* {External references}

View File

@@ -0,0 +1,286 @@
# Developer Onboarding Guide
Welcome to {Project Name}! This guide will help you get up to speed quickly.
## 📋 Checklist
### Day 1
- [ ] Set up development environment
- [ ] Clone repository and install dependencies
- [ ] Run the project locally
- [ ] Read architecture documentation
- [ ] Join team communication channels
### Week 1
- [ ] Complete first small task/bug fix
- [ ] Understand the codebase structure
- [ ] Review coding standards and patterns
- [ ] Set up IDE/tools properly
- [ ] Meet the team
### Month 1
- [ ] Contribute to a feature
- [ ] Understand the deployment process
- [ ] Review Oracle knowledge base
- [ ] Understand testing strategy
## 🚀 Getting Started
### 1. Environment Setup
**Required Tools:**
- Node.js 18+ / Python 3.9+ / etc.
- Git
- IDE (VS Code recommended)
- Docker (optional)
**Installation:**
\`\`\`bash
# Clone repository
git clone https://github.com/{org}/{repo}.git
cd {repo}
# Install dependencies
npm install
# Set up environment
cp .env.example .env
# Edit .env with your configuration
# Run development server
npm run dev
\`\`\`
### 2. Project Structure
\`\`\`
project/
├── src/ # Source code
│ ├── components/ # UI components
│ ├── services/ # Business logic
│ └── utils/ # Utilities
├── tests/ # Test files
├── docs/ # Documentation
└── scripts/ # Build/deployment scripts
\`\`\`
### 3. Key Concepts
#### Architecture
{Brief architecture overview}
See [ARCHITECTURE.md](./ARCHITECTURE.md) for details.
#### Design Patterns
*From Oracle knowledge base:*
- **{Pattern 1}**: {Description}
- **{Pattern 2}**: {Description}
- **{Pattern 3}**: {Description}
## 📚 Essential Reading
1. **README.md** - Project overview
2. **ARCHITECTURE.md** - System architecture
3. **CONTRIBUTING.md** - Contribution guidelines
4. **docs/adr/** - Architecture decisions
5. **Oracle Knowledge** - Project-specific patterns and gotchas
## 🎯 Common Tasks
### Running Tests
\`\`\`bash
# Run all tests
npm test
# Run with coverage
npm run test:coverage
# Run specific test file
npm test path/to/test.spec.ts
\`\`\`
### Building
\`\`\`bash
# Development build
npm run build:dev
# Production build
npm run build:prod
\`\`\`
### Debugging
{Project-specific debugging tips}
## ⚠️ Common Gotchas
*From Oracle knowledge base:*
### {Gotcha 1}
{Description and how to avoid}
### {Gotcha 2}
{Description and how to avoid}
### {Gotcha 3}
{Description and how to avoid}
## 🔧 Development Workflow
### 1. Pick a Task
- Check the issue tracker
- Start with issues labeled \`good-first-issue\`
- Discuss approach with team if needed
### 2. Create a Branch
\`\`\`bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description
\`\`\`
### 3. Make Changes
- Follow coding standards
- Write tests
- Update documentation
### 4. Commit
\`\`\`bash
git add .
git commit -m "feat: add amazing feature"
\`\`\`
We use [Conventional Commits](https://www.conventionalcommits.org/):
- \`feat:\` New feature
- \`fix:\` Bug fix
- \`docs:\` Documentation
- \`refactor:\` Code refactoring
- \`test:\` Tests
- \`chore:\` Maintenance
### 5. Push and Create PR
\`\`\`bash
git push origin feature/your-feature-name
\`\`\`
Then create a Pull Request on GitHub.
## 🎨 Coding Standards
### Style Guide
{Link to style guide or summary}
### Best Practices
*From Oracle knowledge base:*
1. **{Practice 1}**: {Description}
2. **{Practice 2}**: {Description}
3. **{Practice 3}**: {Description}
### Code Review
- All code must be reviewed
- Address all comments
- Ensure tests pass
- Update documentation
## 🧪 Testing Strategy
### Unit Tests
\`\`\`typescript
describe('MyComponent', () => {
it('should render correctly', () => {
// Test code
});
});
\`\`\`
### Integration Tests
{Integration testing approach}
### End-to-End Tests
{E2E testing approach}
## 📖 Learning Resources
### Internal
- **Oracle Knowledge Base**: Project-specific learnings
- **ADRs**: Why we made certain decisions
- **Team Wiki**: {Link}
### External
- {Relevant external resource 1}
- {Relevant external resource 2}
- {Relevant external resource 3}
## 🤝 Team
### Communication Channels
- Slack: #{channel}
- Email: {team-email}
- Standups: {When/Where}
### Key Contacts
- **Tech Lead**: {Name}
- **Product Owner**: {Name}
- **DevOps**: {Name}
## ❓ FAQ
### Q: How do I {common question}?
A: {Answer}
### Q: Where can I find {common need}?
A: {Answer}
### Q: What should I do if {common scenario}?
A: {Answer}
## 🎓 Your First Week
### Suggested Learning Path
**Day 1-2:**
- Complete environment setup
- Read all documentation
- Run the project locally
- Explore the codebase
**Day 3-4:**
- Pick a "good first issue"
- Make your first contribution
- Go through code review
- Merge your first PR
**Day 5:**
- Retrospective on first week
- Questions and clarifications
- Plan for next week
## 🎉 Welcome Aboard!
You're now part of the team! Don't hesitate to ask questions - everyone was new once.
Remember:
- 💬 Ask questions in {channel}
- 📖 Check Oracle knowledge base first
- 🤝 Pair programming is encouraged
- 🎯 Focus on learning, not perfection
---
*Generated by Documentation Wizard • Last updated: {date}*

View File

@@ -0,0 +1,153 @@
# {Project Name}
{Brief description of the project - one or two sentences}
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)
## Overview
{Detailed description of what this project does, why it exists, and what problems it solves}
## Features
- ✨ {Feature 1}
- 🚀 {Feature 2}
- 🔒 {Feature 3}
- 📊 {Feature 4}
## Quick Start
### Prerequisites
- Node.js 18+ (or other runtime)
- {Other prerequisites}
### Installation
\`\`\`bash
npm install
# or
yarn install
\`\`\`
### Basic Usage
\`\`\`typescript
import { Something } from '{package-name}';
// Example code here
const example = new Something();
example.doSomething();
\`\`\`
## Documentation
- 📖 [API Documentation](./docs/api/)
- 🏗️ [Architecture](./docs/ARCHITECTURE.md)
- 📋 [Architecture Decision Records](./docs/adr/)
- 🎨 [Style Guide](./docs/STYLEGUIDE.md)
- 🤝 [Contributing Guidelines](./CONTRIBUTING.md)
## Configuration
\`\`\`typescript
{
// Configuration options
option1: "value1",
option2: "value2"
}
\`\`\`
## Examples
### Example 1: {Use case}
\`\`\`typescript
// Code example
\`\`\`
### Example 2: {Another use case}
\`\`\`typescript
// Code example
\`\`\`
## API Reference
### Main API
#### `functionName(param1, param2)`
Description of what this function does.
**Parameters:**
- `param1` (type): Description
- `param2` (type): Description
**Returns:** Description of return value
**Example:**
\`\`\`typescript
const result = functionName('value1', 'value2');
\`\`\`
## Architecture
{Brief overview of the architecture}
See [ARCHITECTURE.md](./docs/ARCHITECTURE.md) for detailed architecture documentation.
## Development
### Setup Development Environment
\`\`\`bash
npm install
npm run dev
\`\`\`
### Running Tests
\`\`\`bash
npm test
npm run test:coverage
\`\`\`
### Building
\`\`\`bash
npm run build
\`\`\`
## Contributing
We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
### Development Process
1. Fork the repository
2. Create a feature branch (\`git checkout -b feature/amazing-feature\`)
3. Commit your changes (\`git commit -m 'Add amazing feature'\`)
4. Push to the branch (\`git push origin feature/amazing-feature\`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
* {Credit to contributors}
* {Credit to inspirations}
* {Credit to tools/libraries used}
## Support
- 📧 Email: {email}
- 💬 Issues: [GitHub Issues](https://github.com/{user}/{repo}/issues)
- 📖 Documentation: [Full Docs](./docs/)
---
*Generated by Documentation Wizard • Last updated: {date}*