-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(architecture): add architecture.md template and auto-merge on archive #512
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
Open
processtrader
wants to merge
2
commits into
Fission-AI:main
Choose a base branch
from
processtrader:feat-add-architecture-file
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+774
−162
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # System Architecture | ||
|
|
||
| ## Overview | ||
|
|
||
| <!-- High-level system diagram showing major components and their relationships --> | ||
| <!-- Update this diagram as the system evolves --> | ||
|
|
||
| ``` | ||
| ┌─────────────────────────────────────────────────────────────┐ | ||
| │ [Your System Name] │ | ||
| ├─────────────────────────────────────────────────────────────┤ | ||
| │ │ | ||
| │ ┌──────────┐ ┌──────────┐ ┌──────────┐ │ | ||
| │ │ [Client] │───▶│ [API] │───▶│ [DB] │ │ | ||
| │ └──────────┘ └──────────┘ └──────────┘ │ | ||
| │ │ | ||
| └─────────────────────────────────────────────────────────────┘ | ||
| ``` | ||
|
|
||
| ## Components | ||
|
|
||
| <!-- Document each major component/service/module --> | ||
|
|
||
| ### [Component Name] | ||
| - **Responsibility**: [What this component does] | ||
| - **Technology**: [Stack/framework used] | ||
| - **Key files**: [Main entry points, e.g., `src/core/component.ts`] | ||
|
|
||
| <!-- Add more components as your system grows --> | ||
|
|
||
| ## Data Flows | ||
|
|
||
| <!-- Document how data moves through your system --> | ||
|
|
||
| ### [Flow Name] | ||
| ``` | ||
| [Source] ──▶ [Processing] ──▶ [Destination] | ||
| ``` | ||
| - **Trigger**: [What initiates this flow] | ||
| - **Data**: [What data moves through] | ||
|
|
||
| ## Integration Points | ||
|
|
||
| <!-- Document external systems and APIs --> | ||
|
|
||
| | External System | Purpose | Protocol | Notes | | ||
| |-----------------|---------|----------|-------| | ||
| | [Service] | [Why] | [How] | [Details] | | ||
|
|
||
| ## Architectural Decisions | ||
|
|
||
| <!-- This section is automatically updated when archiving changes with architectural impact --> | ||
| <!-- Each row captures a key decision from design.md files --> | ||
|
|
||
| | Date | Decision | Rationale | Status | | ||
| |------|----------|-----------|--------| | ||
| | <!-- Decisions are appended here during archive --> | | ||
|
|
||
| ## Constraints | ||
|
|
||
| <!-- Technical, business, or regulatory constraints affecting architecture --> | ||
|
|
||
| - [Constraint 1]: [Description and impact] | ||
| - [Constraint 2]: [Description and impact] | ||
|
|
||
| --- | ||
|
|
||
| ## Diagram Reference | ||
|
|
||
| <!-- ASCII diagram building blocks for consistency --> | ||
|
|
||
| ``` | ||
| Components: Relationships: Boundaries: | ||
| ┌─────────┐ ───▶ data flow ┌──────────┐ | ||
| │ Service │ ◀─── reverse flow │ Internal │ | ||
| └─────────┘ ←──▶ bidirectional ├──────────┤ | ||
| │ External │ | ||
| Grouping: States: └──────────┘ | ||
| ┌─────────────┐ ○ start state | ||
| │ ┌───┐ ┌───┐ │ ● end state | ||
| │ │ A │ │ B │ │ □ intermediate | ||
| │ └───┘ └───┘ │ | ||
| └─────────────┘ | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.