oleh/astrolabe-nvc
1
0
Fork 0
mirror of https://github.com/olehomelchenko/astrolabe-nvc.git synced 2025-12-21 21:22:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
Oleh Omelchenko
2025-10-18 03:40:10 +03:00
parent 9e72f938e2
commit c755cdd795
2 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CLAUDE.md
View File

@@ -55,4 +55,17 @@ Instructions for Claude Code when working on this project.
- Automatic editor theme synchronization with UI theme
See `docs/dev-plan.md` for complete roadmap and technical details.
- when updating documentation, do not record intermediate changes - write them always as a matter-of-fact information
## Development Principles
- **Iterative**: Each phase produces working, testable functionality
- **Lean**: No frameworks, no build step, minimal dependencies
- **Maintainable**: Clean code organization with logical separation of concerns
- **Simple**: Favor code removal over addition; avoid over-engineering
## General coding instructions
Astrolabe is a project with minimalistic philosophy; it tries to avoid external dependencies and complexity, if possible.
This means that whatever new feature, refactor, or bug fix is being considered, the solution should not be over-engineered unless absolutely necessary. The importance and complexity of a feature defines allowed number of lines of code dedicated to it.
Pay attention to the existing code base style and approaches and try to adhere to the existing style instead of bringing your own vision.
When updating documentation, do not record intermediate changes - write them always as a matter-of-fact information.
When working on the code, if you notice any opportunities to better bring the project to the state above - bring this to user's attention and ask for approval to implement the suggested changes.