Welcome to the EchoLisp development standards documentation. This index helps you navigate all the standards, protocols, and guidelines.

1. STANDARDS_QUICK_REFERENCE.md ⭐ START HERE

   • Quick lookup for common patterns
   • File naming rules
   • Function naming conventions
   • Code style basics
   • Best for: Quick reference while coding

2. DEVELOPMENT_STANDARDS.md 📖

   • Comprehensive development standards
   • File naming conventions in detail
   • Code organization patterns
   • Documentation requirements
   • Best practices for Scheme/Lisp
   • Best for: Understanding the complete standards

3. NAMING_PROTOCOLS.md 🏷️

   • Detailed file extension specifications
   • When to use each extension (.echo.scm, .echo.glisp, etc.)
   • Function and variable naming patterns
   • Directory structure guidelines
   • Migration patterns for existing files
   • Best for: Choosing the right file names and extensions

4. CODING_PATTERNS.md 💡

   • Common implementation patterns
   • Data structure patterns
   • Functional programming patterns
   • Web development patterns
   • Error handling strategies
   • Testing patterns
   • Performance optimization
   • Best for: Learning how to implement common use cases

5. MIGRATION_GUIDE.md 🔄

   • How to transition existing files
   • Migration strategies
   • Batch migration scripts
   • Handling dependencies
   • Testing after migration
   • Best for: Converting existing code to new standards

6. CONTRIBUTING.md 🤝

   • How to contribute to the repository
   • Repository initialization
   • Pull request guidelines
   • Development workflow
   • Best for: Contributing to the project

7. README.md 📝

   • Project overview
   • Getting started
   • Official sources
   • Quick links
   • Best for: Understanding what EchoLisp is

8. .editorconfig ⚙️
   • Editor configuration
   • Indentation settings
   • File-specific formatting
   • Best for: Automatic code formatting

9. examples/ 💻
   • Working code examples
   • Demonstrates standards in practice
   • Four complete examples with different extensions
   • Best for: Learning by example

1. Read STANDARDS_QUICK_REFERENCE.md
2. Choose appropriate extension from NAMING_PROTOCOLS.md
3. Copy structure from examples/
4. Follow patterns from CODING_PATTERNS.md

1. Review MIGRATION_GUIDE.md
2. Choose migration strategy
3. Update file names with .echo. prefix
4. Update imports and references
5. Test thoroughly

1. Read CONTRIBUTING.md
2. Review DEVELOPMENT_STANDARDS.md
3. Check examples/ for code style
4. Submit pull request following guidelines

→ Use .echo.scm extension, see NAMING_PROTOCOLS.md

→ Use .echo.glisp extension, see examples/web-example.echo.glisp

→ See CODING_PATTERNS.md

→ Follow MIGRATION_GUIDE.md

→ Use STANDARDS_QUICK_REFERENCE.md

Rule: All EchoLisp source files MUST use .echo. prefix

✅ module.echo.scm
✅ utils.echo.glisp
✅ helpers.echo.lsp

❌ module.scm
❌ utils.glisp
❌ helpers.lsp

See: NAMING_PROTOCOLS.md

See: NAMING_PROTOCOLS.md

;; Predicates
empty-list?
is-valid?

;; Mutators
set-value!
update-state!

;; Converters
string->number
list->vector

;; Regular functions
calculate-sum
process-data

See: DEVELOPMENT_STANDARDS.md

;; ============================================
;; File: module.echo.scm
;; Purpose: Brief description
;; ============================================

;; Private helpers (prefix with % or -)
(define (%internal-helper x) ...)

;; Public API (with documentation)
;; function-name: arg1 arg2 -> result
(define (function-name arg1 arg2) ...)

See: DEVELOPMENT_STANDARDS.md

• Total Documentation: ~60 pages
• Code Examples: 4 working files
• Patterns Documented: 30+
• Standards Defined: Naming, coding, testing, documentation
• Extensions Covered: 6 types (.scm, .glisp, .lisp, .lsp, .ls, .s)

1. STANDARDS_QUICK_REFERENCE.md
2. examples/hello-world.echo.scm
3. examples/calculator.echo.scm

1. NAMING_PROTOCOLS.md
2. CODING_PATTERNS.md
3. examples/list-utils.echo.lsp

1. DEVELOPMENT_STANDARDS.md
2. CODING_PATTERNS.md (advanced sections)
3. examples/web-example.echo.glisp

1. MIGRATION_GUIDE.md
2. CONTRIBUTING.md
3. All standards documents

• Website: http://www.echolalie.org/echolisp/
• Documentation: https://www.echolalie.org/echolisp/help.html
• Rosetta Code: https://rosettacode.org/wiki/Category:EchoLisp

• Examples: examples/
• Library Files: lib/
• GitHub Actions: .github/workflows/

• File unclear or incorrect? Open an issue
• Missing information? Suggest improvements
• Found a typo? Submit a PR

• Review CODING_PATTERNS.md
• Check examples/
• Ask in discussions

• Check STANDARDS_QUICK_REFERENCE.md
• Review DEVELOPMENT_STANDARDS.md
• Consult NAMING_PROTOCOLS.md

Use this checklist for new files:

• File name uses .echo. prefix
• Appropriate extension chosen
• File header with documentation
• Functions documented with examples
• Code follows style guidelines
• Tests created (if applicable)
• Imports use correct file names
• No hardcoded secrets or sensitive data

1. Start Coding: Use the standards to create new files
2. Migrate Files: Follow the migration guide for existing code
3. Contribute: Submit improvements to the standards
4. Spread the Word: Share these standards with other developers

• v1.0.0 (2026-01-02) - Initial release
  • Complete standards documentation
  • Working examples
  • Migration guide
  • Quick reference

This index is maintained as part of the EchoLisp repository For questions or suggestions, open an issue on GitHub