init projectmycelium
This commit is contained in:
		
							
								
								
									
										18
									
								
								docs/dev/method/current/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/dev/method/current/README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
# Current Method for Dev Working on the Project Mycelium
 | 
			
		||||
 | 
			
		||||
Last updated: 2025-08-12
 | 
			
		||||
 | 
			
		||||
This short index is for developers contributing to the marketplace.
 | 
			
		||||
 | 
			
		||||
## Quick links
 | 
			
		||||
 | 
			
		||||
- [Design method](./design_method.md)
 | 
			
		||||
- [Architecture & Roadmap](../../design/current/projectmycelium-roadmap.md)
 | 
			
		||||
- [DevOps overview](../../../devops.md)
 | 
			
		||||
- [Ops deployment method](../../../ops/method/current/deployment_method.md)
 | 
			
		||||
 | 
			
		||||
## How to use this
 | 
			
		||||
 | 
			
		||||
- Read the architecture & roadmap to align on target design and current status.
 | 
			
		||||
- Pick a TODO item, create a small branch and PR.
 | 
			
		||||
- Keep docs updated: reflect changes in design or ops docs as needed.
 | 
			
		||||
							
								
								
									
										43
									
								
								docs/dev/method/current/design_method.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								docs/dev/method/current/design_method.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,43 @@
 | 
			
		||||
# Project Mycelium Dev Method
 | 
			
		||||
 | 
			
		||||
## Overview
 | 
			
		||||
 | 
			
		||||
This documentation is for developers. Keep the architecture clear and iterate pragmatically. Update this document and the architecture with each meaningful change.
 | 
			
		||||
 | 
			
		||||
## Links
 | 
			
		||||
 | 
			
		||||
- Architecture & Roadmap (authoritative): `docs/dev/design/current/projectmycelium-roadmap.md`
 | 
			
		||||
- Ops deployment method: `docs/ops/method/current/deployment_method.md`
 | 
			
		||||
 | 
			
		||||
## Artifacts
 | 
			
		||||
 | 
			
		||||
- Architecture & Roadmap (single source of truth for design, status, troubleshooting)
 | 
			
		||||
- TODO board/list capturing concrete steps to production
 | 
			
		||||
- Decision Log (mini-ADRs) for key trade-offs under `docs/dev/decisions/` (optional)
 | 
			
		||||
 | 
			
		||||
## Working Mode
 | 
			
		||||
 | 
			
		||||
- Small PRs tied to issues; fast iteration and feedback
 | 
			
		||||
- Keep TODO and architecture updated as the project evolves
 | 
			
		||||
- Schedule regular refactoring and documentation touch-ups
 | 
			
		||||
 | 
			
		||||
## TODO Item Template
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
Title: <concise goal>
 | 
			
		||||
Context: <current state and reason>
 | 
			
		||||
Change: <what will be done>
 | 
			
		||||
Acceptance: <clear criteria/tests>
 | 
			
		||||
Links: <issue/PR/related docs>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Decision Record Template (ADR)
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
Title: <decision>
 | 
			
		||||
Context: <why we need a decision>
 | 
			
		||||
Options: <considered options>
 | 
			
		||||
Decision: <chosen option>
 | 
			
		||||
Consequences: <trade-offs and follow-ups>
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user