Skip to content

Conversation

@nk1408
Copy link
Collaborator

@nk1408 nk1408 commented Nov 11, 2025

Pull Request

Description

Addition of CLAUDE.md for claude code context and documentation in docs/ folder for context to LLM's

Changes Made

Addition of CLAUDE.md, docs/ARCHITECTURE.md, docs/DEBUGGING.md, docs/PATTERNS.md

Checklist

  • I have read the Contributor Guidelines.
  • I have performed a self-review of my own code and ensured it follows the project's coding standards.
  • I have tested the changes locally following ManualTestingProcess.md, and all tests related to this pull request pass.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation, if applicable.
  • I have added appropriate unit tests, if applicable.

Additional Notes

@nk1408 nk1408 requested a review from jooyoungseo November 11, 2025 16:43
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have this separate document here? does it do something else than what CLAUDE.md does?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

professor, the main idea was to keep CLAUDE.md smaller so that context window doesn't bloat, For most of the fixes, the information in CLAUDE.md should be sufficient, but for debugging bigger issues we can reference detailed documentation, so that it would have a better understanding. This was the reco from anthropic as well. Please let me know your thoughts on this. Thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does claude code require debugging document under docs folder?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same reason: Why do we keep this file separately here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

professor, do you think we should keep patterns inside ARCHITECTURE itslef rather than a separate file?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
We need to also make this CLAUDE.md accessible to claude code review workflow yaml. We can also try to reduce the verbose in code reviews as it's very superfluous

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.

4 participants