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
2 changes: 1 addition & 1 deletion .ai
8 changes: 8 additions & 0 deletions .audit/oberstet_modernization-phase-11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- [ ] I did **not** use any AI-assistance tools to help create this pull request.
- [x] I **did** use AI-assistance tools to *help* create this pull request.
- [x] I have read, understood and followed the project's AI_POLICY.md when creating code, documentation etc. for this pull request.

Submitted by: @oberstet
Date: 2025-11-25
Related issue(s): #1784
Branch: oberstet:modernization-phase-1.1
75 changes: 47 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,62 @@
---
name: Report a bug
about:
Report a bug, that is unexpected or undesired behavior for an
existing feature.
title: "[ISSUE] "
labels: ["needs-triage"]
name: Bug Report
about: Report a bug or unexpected behavior
title: '[BUG] '
labels: bug
assignees: ''
---

> 📝 **Note for maintainers:** Please triage this issue (review,
> classify, and assign appropriate labels).
## Bug Description

---
**Summary**: [Brief one-line description of the bug]

## What is your issue about?
**Expected Behavior**:
[What you expected to happen]

<!-- Please provide a clear and concise description. -->
**Actual Behavior**:
[What actually happened]

---
## Reproduction Steps

## Additional context
1. [First step]
2. [Second step]
3. [...]

<!-- Add any other context or screenshots here. -->
**Minimal Reproducible Example**:
```python
# Code that reproduces the issue
```

---
## Environment

## Triage Notes (for maintainers only)
- **Package**: [e.g., autobahn-python, crossbar, txaio]
- **Version**: [e.g., 25.11.1]
- **Python Version**: [e.g., CPython 3.12, PyPy 3.11]
- **Operating System**: [e.g., Ubuntu 24.04, macOS 14, Windows 11]
- **Framework**: [e.g., Twisted 24.7.0, asyncio]

<!--
Triage is reviewing, categorization and prioritizing *bugs* depending on affected system/package/library-area, -layer and -module, disadvantages and impacts, annoyance and urgency.-->
## Additional Context

---
**Error Messages**:
```
[Paste full error/traceback here]
```

**Relevant Logs**:
```
[Paste relevant log excerpts]
```

**Screenshots**:
[If applicable, add screenshots]

**Related Issues**:
- #XXX
- #YYY

## AI Assistance Disclosure
## Checklist

- [ ] I did **not** use any AI-assistance tools to help create
this issue.
- [x] I **did** use AI-assistance tools to _help_ create this
issue.
- [x] I have read, understood and followed the projects'
[AI Policy](https://github.com/crossbario/autobahn-python/blob/main/AI_POLICY.md)
when creating code, documentation etc. for this pull
request.
- [ ] I have searched existing issues to avoid duplicates
- [ ] I have provided a minimal reproducible example
- [ ] I have included version information
- [ ] I have included error messages/logs
12 changes: 9 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Other (General Question, Support, or Not a Bug/Feature)
url: https://github.com/crossbario/autobahn-python/discussions/new
about: Please use GitHub Discussions for all questions, general support, or topics that do not fit a bug or feature request.
- name: 💬 Discussions
url: https://github.com/crossbario/autobahn-python/discussions
about: Ask questions and discuss ideas with the community
- name: 📖 Documentation
url: https://crossbar.io/docs/
about: Read the official documentation
- name: 💡 WAMP Community
url: https://wamp-proto.org/
about: Learn more about the WAMP protocol
92 changes: 65 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,80 @@
---
name: Suggest a feature
about: Suggest a feature, that is new desirable behavior.
title: "[ISSUE] "
labels: ["needs-triage"]
name: Feature Request
about: Suggest a new feature or enhancement
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

> 📝 **Note for maintainers:** Please triage this issue (review,
> classify, and assign appropriate labels).
## Feature Description

---
**Summary**: [Brief one-line description of the feature]

## What is your issue about?
**Problem Statement**:
[What problem does this feature solve? Why do you need it?]

<!-- Please provide a clear and concise description. -->
**Proposed Solution**:
[Describe your proposed solution in detail]

---
## Use Cases

## Additional context
**Use Case 1**:
- **Actor**: [Who uses this feature?]
- **Goal**: [What do they want to achieve?]
- **Example**: [Concrete example]

<!-- Add any other context or screenshots here. -->
**Use Case 2** (if applicable):
- **Actor**: [...]
- **Goal**: [...]
- **Example**: [...]

---
## Example API/Usage

## Triage Notes (for maintainers only)
```python
# Show how you envision the feature being used
```

<!--
Triage is reviewing, categorization and prioritizing *features* depending on affected system/package/library area, layer and module, advantages and risks, desirability and urgency.
-->
## Alternatives Considered

---
**Alternative 1**: [Description]
- Pros: [...]
- Cons: [...]

**Alternative 2**: [Description]
- Pros: [...]
- Cons: [...]

**Why the proposed solution is better**: [Explanation]

## Impact Assessment

**Breaking Changes**: [Yes/No - if yes, describe]

**Affected Components**:
- [ ] Core library
- [ ] API
- [ ] Documentation
- [ ] Tests
- [ ] CI/CD

**Estimated Complexity**: [Low / Medium / High]

## Additional Context

**Related Issues**:
- #XXX
- #YYY

**External References**:
- [Links to relevant specs, discussions, articles]

**Mockups/Diagrams**:
[If applicable, add visual representations]

## AI Assistance Disclosure
## Checklist

- [ ] I did **not** use any AI-assistance tools to help create
this issue.
- [x] I **did** use AI-assistance tools to _help_ create this
issue.
- [x] I have read, understood and followed the projects'
[AI Policy](https://github.com/crossbario/autobahn-python/blob/main/AI_POLICY.md)
when creating code, documentation etc. for this pull
request.
- [ ] I have searched existing issues to avoid duplicates
- [ ] I have described the problem clearly
- [ ] I have provided use cases
- [ ] I have considered alternatives
- [ ] I have assessed impact and breaking changes
139 changes: 139 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
## Description

**Summary**: [Brief one-line description of changes]

**Motivation**: [Why is this change needed? What problem does it solve?]

**Related Issue(s)**: Fixes #XXX

## Type of Change

- [ ] Bug fix (non-breaking change fixing an issue)
- [ ] New feature (non-breaking change adding functionality)
- [ ] Breaking change (fix or feature causing existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Refactoring (no functional changes)
- [ ] Performance improvement
- [ ] Test coverage improvement

## Changes Made

### Core Changes
- [Change 1]
- [Change 2]
- [...]

### API Changes
- [ ] No API changes
- [ ] New API added (backward compatible)
- [ ] API modified (breaking change)
- [ ] API deprecated

### Documentation Changes
- [Doc change 1]
- [Doc change 2]

## Testing

### Test Coverage
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Test coverage maintained or improved
- [ ] All tests pass locally

### Testing Checklist
- [ ] Tested on CPython 3.11
- [ ] Tested on CPython 3.12
- [ ] Tested on CPython 3.13
- [ ] Tested on PyPy 3.11
- [ ] Tested with Twisted (if applicable)
- [ ] Tested with asyncio (if applicable)
- [ ] Tested on Linux
- [ ] Tested on macOS
- [ ] Tested on Windows

### Test Results
```
# Paste test output here
# Example: pytest output, coverage report, etc.
```

## Code Quality

- [ ] Code follows project style guidelines (ruff, black)
- [ ] Type hints added/updated (mypy passes)
- [ ] Docstrings added/updated
- [ ] Comments added for complex logic
- [ ] No new linter warnings
- [ ] No security vulnerabilities introduced

## Performance Impact

- [ ] No performance impact
- [ ] Performance improved
- [ ] Performance regression (justified in description)

**Benchmarks** (if applicable):
```
# Paste benchmark results
```

## Breaking Changes

- [ ] No breaking changes
- [ ] Breaking changes documented below

**Breaking Changes Description**:
[Describe what breaks and migration path]

**Migration Guide**:
```python
# Before
old_api()

# After
new_api()
```

## Deployment Notes

- [ ] No special deployment steps required
- [ ] Database migration needed
- [ ] Configuration changes needed
- [ ] Dependencies updated

**Deployment Steps** (if applicable):
1. [Step 1]
2. [Step 2]

## Screenshots/Recordings

[If applicable, add screenshots or recordings demonstrating the changes]

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published

## AI Assistance Disclosure

- [ ] This PR was created entirely by a human
- [ ] This PR was created with AI assistance

**If AI-assisted, please provide details**:
- **AI Tool**: [e.g., Claude Code, GitHub Copilot]
- **Scope of AI Assistance**: [e.g., "Code refactoring suggestions", "Test generation", "Documentation writing"]
- **Human Review**: [Describe how you reviewed and validated the AI-generated content]

**Note**: Per AI_POLICY.md, you (the human) are the sole author of this contribution.
AI assistance is acknowledged but does not constitute co-authorship.

## Additional Notes

[Any additional context, concerns, or discussion points]
Loading