Skip to content

Comments

ADR-003 Use Single-Process Approach for Architecture Requests + Issue templates#5

Merged
jhagberg merged 4 commits intomainfrom
adr/003
Dec 10, 2025
Merged

ADR-003 Use Single-Process Approach for Architecture Requests + Issue templates#5
jhagberg merged 4 commits intomainfrom
adr/003

Conversation

@jhagberg
Copy link
Contributor

@jhagberg jhagberg commented Nov 26, 2025

Add GitHub Issue Templates and Labels

Summary

This PR adds GitHub integration to make it easy for people to ask architecture questions:

  • Issue template for architecture-question
  • Configuration for additional contact links
  • Proposed label structure for workflow management

Proposed Labels

I suggest we create these labels manually after merging:

Core Labels (Recommended to Create)

Label Color Description When Applied
architecture-question #0E8A16 Questions for board Always (auto by template)
high-impact #D93F0B Affects all platforms Optional (when relevant)
urgent #B60205 Needs quick response Rare (sparingly used)
adr-needed #5319E7 Should become ADR Board adds (during discussion)

Usage pattern:

  • Every issue gets: architecture-question (automatically)
  • Some issues get: high-impact (when affects all platforms)
  • Few issues get: urgent (only when truly time-sensitive)
  • Board adds: adr-needed (during discussion if precedent-setting)

Optional Status Labels

Label Color Description Usage
needs-decision #FBCA04 (yellow) Discussion ongoing, decision pending Board workflow
waiting-for-feedback #FEF2C0 (light yellow) Waiting for requester response Board workflow
resolved #0E8A16 (green) Question answered Board closes issue

Optional Category Labels

Label Color Description
integration #1D76DB (blue) Integration between systems
standards #1D76DB (blue) Standards and specifications
security #D93F0B (red) Security-related
infrastructure #BFD4F2 (light blue) Hardware/storage/compute

Discussion question: Should we start with just the 4 core labels and add more as needed? Or create the full set upfront?

Blank Issues: Enabled ✅

Set to true to lower barrier. Anyone can open issue without template.

Rationale: Better to be welcoming than strict. We can require templates later if needed.

Question: Agree, or should we require template usage?

Discussion Questions for Reviewers

  1. Label set: Start with 4 core labels or create all 11 upfront?
  2. Blank issues: Keep enabled (true) or require template (false)?
  3. Template tone: Too casual? Too formal? Just right?
  4. Template fields: Missing anything important? Too many fields?
  5. Contact links: Should we add Slack channel if we create one?

@jhagberg jhagberg requested a review from a team November 26, 2025 11:39
@alneberg
Copy link
Member

How could the core labels be useful if they are required? For example if everything is labelled urgent? I'm probably just misunderstanding something though.

@jhagberg
Copy link
Contributor Author

jhagberg commented Nov 28, 2025

Great question! Sorry poor wording on my part.

I mean
"These are the core labels we must CREATE in the repository"
NOT "These labels must be applied to every issue"
I will update the PR text!

How could the core labels be useful if they are required? For example if everything is labelled urgent? I'm probably just misunderstanding something though.

@jwindhager
Copy link
Member

jwindhager commented Dec 2, 2025

My 2C:

Label set: Start with 4 core labels or create all 11 upfront?

All upfront and later discard unused

Blank issues: Keep enabled (true) or require template (false)?

True

Template tone: Too casual? Too formal? Just right?

Just right

Template fields: Missing anything important? Too many fields?

Good for now, expand later if we realize something is missing

Contact links: Should we add Slack channel if we create one?

Would vote for prominently adding the Slack channel on the homepage, but not in the issue template

Actually, because of transparency reasons, I'd advise against a Slack channel

Copy link
Member

@jwindhager jwindhager left a comment

Choose a reason for hiding this comment

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

LGTM, we can refine the process later (e.g. add minimum time for which an ADR PR needs to remain open to collect community feedback)

@jhagberg
Copy link
Contributor Author

jhagberg commented Dec 8, 2025

@jwindhager thanks for you comments and feedback!

@jhagberg jhagberg requested a review from jwindhager December 8, 2025 10:07
Copy link
Member

@alneberg alneberg left a comment

Choose a reason for hiding this comment

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

Looks good from what I can tell, I don't have much experience with the github templates though. I agree with the comment regarding some more examples.

…ignees fields for consistency, and adding additional example questions to guide users in seeking architectural guidance.
@jhagberg jhagberg merged commit ef8c692 into main Dec 10, 2025
1 check passed
@jhagberg jhagberg deleted the adr/003 branch December 10, 2025 13:06
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.

5 participants