Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/contract-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 📜 Contract Proposal
description: Propose a new semantic contract for the catalog
title: "[Contract Proposal]: "
labels: ["new-contract", "needs-validation"]
body:
- type: markdown
attributes:
value: |
## How This Works

Propose a new semantic contract — a composition of anchors that defines behavior for a specific workflow or context.

1. **You provide the contract name and scope**
2. **Maintainers validate** whether it meets the contract criteria
3. **If accepted**: The contract is implemented and a PR is submitted
4. **If rejected**: Maintainers explain why

- type: input
id: term
attributes:
label: Proposed Contract Name
description: The name of the semantic contract you want to propose
placeholder: "e.g., \"Architecture Documentation\", \"Code Review\", \"Requirements Discovery\""
validations:
required: true

- type: textarea
id: anchors
attributes:
label: Constituent Anchors
description: Which existing anchors should this contract compose?
placeholder: |
- arc42
- c4-diagrams
- madr
validations:
required: true

- type: textarea
id: context
attributes:
label: Context & Use Case
description: When and why would someone activate this contract?
placeholder: Describe the workflow or scenario this contract supports
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: The constituent anchors already exist in the catalog
required: true
- label: This contract addresses a recurring workflow (not a one-off)
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/process-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: ⚙️ Process Proposal
description: Propose a change to project processes or governance
title: "[Process Proposal]: "
labels: ["process", "discussion"]
body:
- type: markdown
attributes:
value: |
## Process Change Proposal

Suggest a change to how the project operates — contribution workflows, review policies, naming conventions, automation, etc.

- type: input
id: title
attributes:
label: Proposal Title
description: A concise name for the process change
placeholder: "e.g., \"Make evaluation specs mandatory for new anchors\""
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this process change solve?
placeholder: |
Currently...
This causes...
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed Change
description: What specifically should change?
placeholder: |
I propose that...
validations:
required: true

- type: textarea
id: impact
attributes:
label: Impact Assessment
description: Who is affected and what's the cost of adoption?
placeholder: |
- Affected parties: ...
- Migration effort: ...
- Risk: ...
validations:
required: false
46 changes: 46 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,52 @@ For *code changes*:
This project uses *CodeRabbit* for automated AI code review on all PRs.
CodeRabbit reviews are advisory — human maintainer approval is still required.

== Issue Title Convention

All issues should follow a consistent `[Type]: <Name>` title format. This makes filtering, searching, and triaging materially easier.

=== Recognized Prefixes

[cols="1,2,1"]
|===
| Prefix | Used For | Source

| `[Anchor Proposal]:`
| New semantic anchor proposals
| Issue template

| `[Contract Proposal]:`
| New semantic contract proposals
| Issue template

| `[Improve]:`
| Improvements to existing anchors
| Issue template

| `[Bug]:`
| Bug reports
| Issue template

| `[Process Proposal]:`
| Changes to project processes
| Issue template

| `[Feature]:`
| Feature requests
| Free-form

| `EPIC:`
| Tracking issues for larger initiatives
| Free-form
|===

=== Guidelines

* *Use the issue template* whenever one exists — the prefix is set automatically.
* *Free-form issues* (no matching template) should manually use one of the recognized prefixes.
* *Apply going forward only* — do not retro-rename closed issues.
* *EPICs* use the bare `EPIC:` prefix without brackets, as a sanctioned exception.

== Code of Conduct

* Be respectful and constructive in discussions
Expand Down
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,29 @@ npm run build
3. Maintainers create the anchor file and PR
4. Community reviews the PR

## Issue Title Convention

All issues should follow a consistent `[Type]: <Name>` title format. This makes filtering, searching, and triaging materially easier.

### Recognized Prefixes

| Prefix | Used For | Source |
|--------|----------|--------|
| `[Anchor Proposal]:` | New semantic anchor proposals | Issue template |
| `[Contract Proposal]:` | New semantic contract proposals | Issue template |
| `[Improve]:` | Improvements to existing anchors | Issue template |
| `[Bug]:` | Bug reports | Issue template |
| `[Process Proposal]:` | Changes to project processes | Issue template |
| `[Feature]:` | Feature requests | Free-form |
| `EPIC:` | Tracking issues for larger initiatives | Free-form |

### Guidelines

- **Use the issue template** whenever one exists — the prefix is set automatically.
- **Free-form issues** (no matching template) should manually use one of the recognized prefixes.
- **Apply going forward only** — do not retro-rename closed issues.
- **EPICs** use the bare `EPIC:` prefix without brackets, as a sanctioned exception.

## Code of Conduct

### Our Pledge
Expand Down
46 changes: 46 additions & 0 deletions docs/CONTRIBUTING.de.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,52 @@ Anker sind mit beruflichen Rollen getaggt, um relevante Inhalte zu filtern:
. Team Lead / Engineering Manager
. Educator / Trainer

== Issue-Titel-Konvention

Alle Issues sollten einem konsistenten `[Typ]: <Name>` Titelformat folgen. Dies macht Filtern, Suchen und Triagieren wesentlich einfacher.

=== Anerkannte Prefixe

[cols="1,2,1"]
|===
| Prefix | Verwendet für | Quelle

| `[Anchor Proposal]:`
| Vorschläge für neue semantische Anker
| Issue-Template

| `[Contract Proposal]:`
| Vorschläge für neue semantische Contracts
| Issue-Template

| `[Improve]:`
| Verbesserungen an bestehenden Ankern
| Issue-Template

| `[Bug]:`
| Fehlermeldungen
| Issue-Template

| `[Process Proposal]:`
| Änderungen an Projektprozessen
| Issue-Template

| `[Feature]:`
| Feature-Anfragen
| Frei formuliert

| `EPIC:`
| Tracking-Issues für größere Initiativen
| Frei formuliert
|===

=== Richtlinien

* *Verwenden Sie das Issue-Template*, wann immer eines existiert — das Prefix wird automatisch gesetzt.
* *Frei formulierte Issues* (kein passendes Template) sollten manuell eines der anerkannten Prefixe verwenden.
* *Nur zukünftig anwenden* — geschlossene Issues nicht rückwirkend umbenennen.
* *EPICs* verwenden das bloße `EPIC:` Prefix ohne Klammern als anerkannte Ausnahme.

== Verhaltenskodex

* Seien Sie respektvoll und konstruktiv in Diskussionen
Expand Down
Loading