Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add an ARCHITECTURE.md file #67

Open
kurosakishigure opened this issue Dec 12, 2024 · 1 comment
Open

docs: Add an ARCHITECTURE.md file #67

kurosakishigure opened this issue Dec 12, 2024 · 1 comment
Labels
documentation Add or improve docs(issue or PR) good first issue Easy to fix issue(triage)

Comments

@kurosakishigure
Copy link
Owner

Page Link

https://github.com/kurosakishigure/katharsis

What is the documentation issue?

We are missing an ARCHITECTURE.md file to describe the overall architecture of the project.

Is there any context that might help us understand?

Including an ARCHITECTURE.md file will make it easier for contributors to understand the project.

@kurosakishigure kurosakishigure added the documentation Add or improve docs(issue or PR) label Dec 12, 2024
@kurosakishigure kurosakishigure changed the title Add an ARCHITECTURE.md file doc: Add an ARCHITECTURE.md file Dec 31, 2024
@kurosakishigure kurosakishigure pinned this issue Jan 1, 2025
@kurosakishigure kurosakishigure changed the title doc: Add an ARCHITECTURE.md file docs: Add an ARCHITECTURE.md file Jan 5, 2025
@kurosakishigure kurosakishigure added the good first issue Easy to fix issue(triage) label Jan 6, 2025
Copy link

github-actions bot commented Jan 6, 2025

The issue was marked with the good first issue label by a maintainer.

This means that it is a good candidate for someone interested in contributing to the project, but does not know where to start.

Note

To get started, read the Contributing Guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve docs(issue or PR) good first issue Easy to fix issue(triage)
Projects
None yet
Development

No branches or pull requests

1 participant