-
Notifications
You must be signed in to change notification settings - Fork 0
ADR-003 Use Single-Process Approach for Architecture Requests + Issue templates #5
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
9e5cb6d
Add architecture question issue template and decision document for un…
jhagberg 63b8b12
Add issue template configuration for architecture inquiries and direc…
jhagberg 97e5935
Update title of architecture decision record to include ADR prefix fo…
jhagberg 0372db9
Refine architecture question issue template by updating title and ass…
jhagberg 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| name: Architecture Question | ||
| about: Ask the architecture board for guidance or consultation | ||
| title: "" | ||
| labels: architecture-question | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## What do you need help with? | ||
|
|
||
| <!-- | ||
| No question is too small! We'd rather you ask early than fix expensive mistakes later. | ||
|
|
||
| Examples: | ||
| - "Should I use REST or GraphQL for this API?" | ||
| - "How do I integrate with the user portal?" | ||
| - "Is there a standard for sample metadata?" | ||
| - "Can you review my design?" | ||
| - "Is there an existing solution for X that I should build upon" | ||
| - "Has another team already solved this problem?" | ||
| - "What are other groups doing for authentication that I could align with?" | ||
| - "Are there existing patterns or libraries I should reuse for this?" | ||
| --> | ||
|
|
||
| ## Context | ||
|
|
||
| <!-- What are you building or planning? Any background that helps us understand? --> | ||
|
|
||
| ## What you've considered (optional) | ||
|
|
||
| <!-- | ||
| If you've thought about options, share them. If not, that's totally fine! | ||
| We're here to help you think through it. | ||
| --> | ||
|
|
||
| ## Timeline | ||
|
|
||
| <!-- When do you need guidance? No pressure, just helps us prioritize. --> | ||
|
|
||
| ## Additional Information | ||
|
|
||
| <!-- Anything else that might be helpful? Diagrams, links, examples? --> | ||
|
|
||
| --- | ||
|
|
||
| 💡 **Tip:** For urgent requests, add the `urgent` label. For decisions affecting all platforms, consider adding `high-impact`. | ||
|
|
||
| 🤝 **We're here to help!** Response time target: 2 weeks for initial feedback. | ||
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,8 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: 📚 Documentation | ||
| url: https://scilifelab.github.io/architecture/ | ||
| about: Read our process documentation and existing decisions | ||
| - name: 💬 Direct Contact | ||
| url: mailto:architecture@scilifelab.se | ||
| about: Email the architecture board directly |
98 changes: 98 additions & 0 deletions
98
docs/decisions/0003-use-single-process-approach-for-architecture-requests.md
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,98 @@ | ||
| # ADR-0003. Use Single-Process Approach for Architecture Requests | ||
|
|
||
| Date: 2025-11-26 | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted | ||
|
|
||
| ## Context | ||
|
|
||
| Architecture governance can use tiered processes (Quick Reviews → ADRs → RFCs) where requesters must choose the appropriate tier. However, this creates: | ||
|
|
||
| - Cognitive overhead: "Which tier is this?" | ||
| - Procedural confusion about process selection | ||
| - Need to migrate requests between tiers | ||
| - Higher barrier to asking questions | ||
|
|
||
| We want to encourage early engagement before problems become expensive. | ||
|
|
||
| ## Decision | ||
|
|
||
| Use a **single unified process** where formality emerges naturally from impact. | ||
|
|
||
| **Process:** | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| A[Open Issue] --> B{Discussion<br/>Time varies} | ||
| B -->|Simple| C[Close with<br/>Answer] | ||
| B -->|Complex| D[Create ADR PR] | ||
| D --> E[Publish] | ||
|
|
||
| style A fill:#e1f5ff | ||
| style D fill:#fff4e1 | ||
| style E fill:#e8f5e9 | ||
| ``` | ||
|
|
||
| **Key insight:** Same process, different discussion length based on natural impact. | ||
|
|
||
| **Label:** `architecture-question` | ||
|
|
||
| **Optional:** `high-impact`, `urgent` | ||
|
|
||
| ## Rationale | ||
|
|
||
| **Single process eliminates confusion:** | ||
|
|
||
| - No tier selection needed | ||
| - No migrations between systems | ||
| - Natural scaling based on impact | ||
|
|
||
| **Formality emerges from context:** | ||
|
|
||
| | Impact | Discussion | Outcome | | ||
| | ------ | ---------- | --------------- | | ||
| | Low | 3-5 days | Answer in issue | | ||
| | Medium | 1-2 weeks | Likely ADR | | ||
| | High | 2-4 weeks | Definitely ADR | | ||
|
|
||
| **"Question" lowers barrier:** | ||
|
|
||
| - Less intimidating than "decision" | ||
| - Encourages early consultation | ||
| - Welcomes exploratory discussion | ||
|
|
||
| ## Consequences | ||
|
|
||
| **Positive:** | ||
|
|
||
| - Simple for requesters | ||
| - Lower barrier to engagement | ||
| - Fast for simple questions | ||
| - Still rigorous for important decisions | ||
| - Everything transparent (issues + ADRs) | ||
|
|
||
| **Negative:** | ||
|
|
||
| - Less formal than traditional governance | ||
| - Board must identify when to create ADR | ||
|
|
||
| **Implementation:** | ||
|
|
||
| - Issue template: `architecture-question` | ||
| - Process docs emphasize "ask early, ask often" | ||
| - ADRs for precedent-setting decisions only | ||
|
|
||
| ## Alternatives Considered | ||
|
|
||
| **Three-tier system:** Clear separation but high cognitive overhead | ||
|
|
||
| **ADR-only:** Everything documented but too slow for simple questions | ||
|
|
||
| **RFC-heavy:** Very formal but overkill for our multi-project context | ||
|
|
||
| ## References | ||
|
|
||
| - [OME-NGFF RFC Process](https://ngff.openmicroscopy.org) | ||
| - [ADR GitHub Repository](https://adr.github.io/) |
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.