Skip to content

docs: update CLAUDE.md with language spec structure guidance#2505

Merged
xushiwei merged 1 commit intomainfrom
xgopilot/claude/issue-2504-1765241446
Dec 9, 2025
Merged

docs: update CLAUDE.md with language spec structure guidance#2505
xushiwei merged 1 commit intomainfrom
xgopilot/claude/issue-2504-1765241446

Conversation

@xgopilot
Copy link

@xgopilot xgopilot bot commented Dec 9, 2025

Requested by @xushiwei

This PR updates CLAUDE.md to incorporate XGo's language specification structure information as requested in issue #2504.

Summary

  • Added comprehensive documentation about XGo's dual-level specification system
  • Documented MiniSpec (recommended best practices for all users) and FullSpec (complete syntax for experts)
  • Included clear guidance on which files to update for each spec type
  • Added decision criteria for classifying new syntax features
  • Provided update process for maintaining specifications

Changes

  • Language Specification Structure section added to CLAUDE.md with:
    • MiniSpec documentation: purpose, audience, and files (doc/spec-mini.md, doc/spec/mini/mini.xgo)
    • FullSpec documentation: purpose, audience, and files (doc/spec.md)
    • Decision criteria for determining whether new syntax belongs in MiniSpec or FullSpec
    • Step-by-step update process for documentation

Context

Closes #2504

This enhancement ensures that when adding new syntax to XGo, developers have clear guidance on:

  1. The distinction between MiniSpec and FullSpec
  2. Which specification documents need to be updated
  3. How to determine the appropriate classification for new syntax features

Add comprehensive documentation about XGo's dual-level specification system:
- MiniSpec: Recommended best practices for all users
- FullSpec: Complete syntax set for experts and library designers

Include clear guidance on:
- Purpose and audience for each spec level
- Which files to update for each spec type
- Decision criteria for classifying new syntax
- Update process for documentation

This addresses issue #2504 by incorporating the language spec
information into the AI assistant guide.

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: xushiwei <[email protected]>
@codecov
Copy link

codecov bot commented Dec 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.98%. Comparing base (db25915) to head (38fb947).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2505   +/-   ##
=======================================
  Coverage   93.98%   93.98%           
=======================================
  Files          34       34           
  Lines        9613     9613           
=======================================
  Hits         9035     9035           
  Misses        413      413           
  Partials      165      165           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@xushiwei xushiwei merged commit fbc70d0 into main Dec 9, 2025
29 checks passed
@xushiwei xushiwei deleted the xgopilot/claude/issue-2504-1765241446 branch December 9, 2025 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update CLAUSE.md by incorporating the language spec of XGo

2 participants