Skip to content

docs: establish singleton pattern guidelines for SDOF prevention#198

Merged
kcenon merged 2 commits into
mainfrom
docs/singleton-guidelines-197
Dec 15, 2025
Merged

docs: establish singleton pattern guidelines for SDOF prevention#198
kcenon merged 2 commits into
mainfrom
docs/singleton-guidelines-197

Conversation

@kcenon

@kcenon kcenon commented Dec 15, 2025

Copy link
Copy Markdown
Owner

Summary

  • Add comprehensive singleton pattern guidelines document (SINGLETON_GUIDELINES.md)
  • Add Korean translation (SINGLETON_GUIDELINES_KO.md)
  • Complete common_system singleton audit with recommendations
  • Update documentation index with new guidelines links

Changes

Documentation Added

  • docs/SINGLETON_GUIDELINES.md - English version with:

    • Meyer's Singleton pattern documentation
    • Intentional Leak pattern for infrastructure singletons
    • common_system audit results (event_bus, GlobalLoggerRegistry)
    • Static destruction safety checklist
    • Code review checklist
    • Migration guide
  • docs/SINGLETON_GUIDELINES_KO.md - Korean translation

Documentation Updated

  • docs/README.md - Added link in Advanced Topics section
  • docs/README_KO.md - Added link in Development Guidelines section

common_system Audit Results

Singleton Current Pattern SDOF Risk Recommendation
simple_event_bus::instance() Meyer's Singleton ⚠️ Medium Consider Intentional Leak
GlobalLoggerRegistry::instance() Meyer's Singleton ⚠️ Medium Consider Intentional Leak
GlobalLoggerRegistry::null_logger() Meyer's Singleton ✅ Low Acceptable

Test Plan

  • Verify markdown renders correctly on GitHub
  • Check all internal links work
  • Verify Korean translation accuracy
  • Review by maintainers

Closes #197

- Add SINGLETON_GUIDELINES.md with Meyer's Singleton and Intentional
  Leak patterns documentation
- Add Korean translation SINGLETON_GUIDELINES_KO.md
- Include common_system singleton audit results
- Document code review checklist and migration guide
- Reference related issues across thread_system and network_system

Closes #197
- Add SINGLETON_GUIDELINES.md to advanced topics in README.md
- Add Korean version link to README_KO.md development guidelines section
@kcenon kcenon merged commit 788c60f into main Dec 15, 2025
19 checks passed
@kcenon kcenon deleted the docs/singleton-guidelines-197 branch December 15, 2025 04:58
kcenon added a commit that referenced this pull request Apr 13, 2026
* docs: add singleton pattern guidelines for SDOF prevention

- Add SINGLETON_GUIDELINES.md with Meyer's Singleton and Intentional
  Leak patterns documentation
- Add Korean translation SINGLETON_GUIDELINES_KO.md
- Include common_system singleton audit results
- Document code review checklist and migration guide
- Reference related issues across thread_system and network_system

Closes #197

* docs: add singleton guidelines links to documentation index

- Add SINGLETON_GUIDELINES.md to advanced topics in README.md
- Add Korean version link to README_KO.md development guidelines section
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.

docs: establish singleton pattern guidelines for ecosystem to prevent SDOF

1 participant