Skip to content

Commit d0eeada

Browse files
oberstetoberstet
authored
Modernization phase 1.1 (#1785)
* Phase 1.1: Update Git submodules for infrastructure Updated .ai and .cicd submodules to latest Phase 0 improvements: - .ai: Updated to ef27ea8 - Fixed audit file generation recipe - Simplified AI_POLICY.md reference - Proper GitHub username extraction - .cicd: Updated to a5550cb - GitHub Issue/PR templates - validate-audit-file GitHub Action Part of WAMP ecosystem Phase 1.1 modernization. Note: This work was completed with AI assistance (Claude Code). * Add audit file for Phase 1.1 changes * Phase 1.1: Deploy GitHub Issue/PR templates Updated .cicd submodule to e3d9e93 and deployed Issue/PR templates to .github/ directory. Note: This work was completed with AI assistance (Claude Code).
1 parent e70125b commit d0eeada

File tree

7 files changed

+270
-60
lines changed

7 files changed

+270
-60
lines changed

‎.ai‎

‎.audit/oberstet_modernization-phase-11.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
- [ ] I did **not** use any AI-assistance tools to help create this pull request.
2+
- [x] I **did** use AI-assistance tools to *help* create this pull request.
3+
- [x] I have read, understood and followed the project's AI_POLICY.md when creating code, documentation etc. for this pull request.
4+
5+
Submitted by: @oberstet
6+
Date: 2025-11-25
7+
Related issue(s): #1784
8+
Branch: oberstet:modernization-phase-1.1

‎.cicd‎

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 47 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,62 @@
11
---
2-
name: Report a bug
3-
about:
4-
Report a bug, that is unexpected or undesired behavior for an
5-
existing feature.
6-
title: "[ISSUE] "
7-
labels: ["needs-triage"]
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
87
---
98

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

13-
---
11+
**Summary**: [Brief one-line description of the bug]
1412

15-
## What is your issue about?
13+
**Expected Behavior**:
14+
[What you expected to happen]
1615

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

19-
---
19+
## Reproduction Steps
2020

21-
## Additional context
21+
1. [First step]
22+
2. [Second step]
23+
3. [...]
2224

23-
<!-- Add any other context or screenshots here. -->
25+
**Minimal Reproducible Example**:
26+
```python
27+
# Code that reproduces the issue
28+
```
2429

25-
---
30+
## Environment
2631

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

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

32-
---
40+
**Error Messages**:
41+
```
42+
[Paste full error/traceback here]
43+
```
44+
45+
**Relevant Logs**:
46+
```
47+
[Paste relevant log excerpts]
48+
```
49+
50+
**Screenshots**:
51+
[If applicable, add screenshots]
52+
53+
**Related Issues**:
54+
- #XXX
55+
- #YYY
3356

34-
## AI Assistance Disclosure
57+
## Checklist
3558

36-
- [ ] I did **not** use any AI-assistance tools to help create
37-
this issue.
38-
- [x] I **did** use AI-assistance tools to _help_ create this
39-
issue.
40-
- [x] I have read, understood and followed the projects'
41-
[AI Policy](https://github.com/crossbario/autobahn-python/blob/main/AI_POLICY.md)
42-
when creating code, documentation etc. for this pull
43-
request.
59+
- [ ] I have searched existing issues to avoid duplicates
60+
- [ ] I have provided a minimal reproducible example
61+
- [ ] I have included version information
62+
- [ ] I have included error messages/logs

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Other (General Question, Support, or Not a Bug/Feature)
4-
url: https://github.com/crossbario/autobahn-python/discussions/new
5-
about: Please use GitHub Discussions for all questions, general support, or topics that do not fit a bug or feature request.
3+
- name: 💬 Discussions
4+
url: https://github.com/crossbario/autobahn-python/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📖 Documentation
7+
url: https://crossbar.io/docs/
8+
about: Read the official documentation
9+
- name: 💡 WAMP Community
10+
url: https://wamp-proto.org/
11+
about: Learn more about the WAMP protocol

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 65 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,80 @@
11
---
2-
name: Suggest a feature
3-
about: Suggest a feature, that is new desirable behavior.
4-
title: "[ISSUE] "
5-
labels: ["needs-triage"]
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
67
---
78

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

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

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

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

17-
---
19+
## Use Cases
1820

19-
## Additional context
21+
**Use Case 1**:
22+
- **Actor**: [Who uses this feature?]
23+
- **Goal**: [What do they want to achieve?]
24+
- **Example**: [Concrete example]
2025

21-
<!-- Add any other context or screenshots here. -->
26+
**Use Case 2** (if applicable):
27+
- **Actor**: [...]
28+
- **Goal**: [...]
29+
- **Example**: [...]
2230

23-
---
31+
## Example API/Usage
2432

25-
## Triage Notes (for maintainers only)
33+
```python
34+
# Show how you envision the feature being used
35+
```
2636

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

31-
---
39+
**Alternative 1**: [Description]
40+
- Pros: [...]
41+
- Cons: [...]
42+
43+
**Alternative 2**: [Description]
44+
- Pros: [...]
45+
- Cons: [...]
46+
47+
**Why the proposed solution is better**: [Explanation]
48+
49+
## Impact Assessment
50+
51+
**Breaking Changes**: [Yes/No - if yes, describe]
52+
53+
**Affected Components**:
54+
- [ ] Core library
55+
- [ ] API
56+
- [ ] Documentation
57+
- [ ] Tests
58+
- [ ] CI/CD
59+
60+
**Estimated Complexity**: [Low / Medium / High]
61+
62+
## Additional Context
63+
64+
**Related Issues**:
65+
- #XXX
66+
- #YYY
67+
68+
**External References**:
69+
- [Links to relevant specs, discussions, articles]
70+
71+
**Mockups/Diagrams**:
72+
[If applicable, add visual representations]
3273

33-
## AI Assistance Disclosure
74+
## Checklist
3475

35-
- [ ] I did **not** use any AI-assistance tools to help create
36-
this issue.
37-
- [x] I **did** use AI-assistance tools to _help_ create this
38-
issue.
39-
- [x] I have read, understood and followed the projects'
40-
[AI Policy](https://github.com/crossbario/autobahn-python/blob/main/AI_POLICY.md)
41-
when creating code, documentation etc. for this pull
42-
request.
76+
- [ ] I have searched existing issues to avoid duplicates
77+
- [ ] I have described the problem clearly
78+
- [ ] I have provided use cases
79+
- [ ] I have considered alternatives
80+
- [ ] I have assessed impact and breaking changes

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
## Description
2+
3+
**Summary**: [Brief one-line description of changes]
4+
5+
**Motivation**: [Why is this change needed? What problem does it solve?]
6+
7+
**Related Issue(s)**: Fixes #XXX
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix (non-breaking change fixing an issue)
12+
- [ ] New feature (non-breaking change adding functionality)
13+
- [ ] Breaking change (fix or feature causing existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Refactoring (no functional changes)
16+
- [ ] Performance improvement
17+
- [ ] Test coverage improvement
18+
19+
## Changes Made
20+
21+
### Core Changes
22+
- [Change 1]
23+
- [Change 2]
24+
- [...]
25+
26+
### API Changes
27+
- [ ] No API changes
28+
- [ ] New API added (backward compatible)
29+
- [ ] API modified (breaking change)
30+
- [ ] API deprecated
31+
32+
### Documentation Changes
33+
- [Doc change 1]
34+
- [Doc change 2]
35+
36+
## Testing
37+
38+
### Test Coverage
39+
- [ ] Unit tests added/updated
40+
- [ ] Integration tests added/updated
41+
- [ ] Test coverage maintained or improved
42+
- [ ] All tests pass locally
43+
44+
### Testing Checklist
45+
- [ ] Tested on CPython 3.11
46+
- [ ] Tested on CPython 3.12
47+
- [ ] Tested on CPython 3.13
48+
- [ ] Tested on PyPy 3.11
49+
- [ ] Tested with Twisted (if applicable)
50+
- [ ] Tested with asyncio (if applicable)
51+
- [ ] Tested on Linux
52+
- [ ] Tested on macOS
53+
- [ ] Tested on Windows
54+
55+
### Test Results
56+
```
57+
# Paste test output here
58+
# Example: pytest output, coverage report, etc.
59+
```
60+
61+
## Code Quality
62+
63+
- [ ] Code follows project style guidelines (ruff, black)
64+
- [ ] Type hints added/updated (mypy passes)
65+
- [ ] Docstrings added/updated
66+
- [ ] Comments added for complex logic
67+
- [ ] No new linter warnings
68+
- [ ] No security vulnerabilities introduced
69+
70+
## Performance Impact
71+
72+
- [ ] No performance impact
73+
- [ ] Performance improved
74+
- [ ] Performance regression (justified in description)
75+
76+
**Benchmarks** (if applicable):
77+
```
78+
# Paste benchmark results
79+
```
80+
81+
## Breaking Changes
82+
83+
- [ ] No breaking changes
84+
- [ ] Breaking changes documented below
85+
86+
**Breaking Changes Description**:
87+
[Describe what breaks and migration path]
88+
89+
**Migration Guide**:
90+
```python
91+
# Before
92+
old_api()
93+
94+
# After
95+
new_api()
96+
```
97+
98+
## Deployment Notes
99+
100+
- [ ] No special deployment steps required
101+
- [ ] Database migration needed
102+
- [ ] Configuration changes needed
103+
- [ ] Dependencies updated
104+
105+
**Deployment Steps** (if applicable):
106+
1. [Step 1]
107+
2. [Step 2]
108+
109+
## Screenshots/Recordings
110+
111+
[If applicable, add screenshots or recordings demonstrating the changes]
112+
113+
## Checklist
114+
115+
- [ ] My code follows the project's style guidelines
116+
- [ ] I have performed a self-review of my code
117+
- [ ] I have commented my code, particularly in hard-to-understand areas
118+
- [ ] I have made corresponding changes to the documentation
119+
- [ ] My changes generate no new warnings
120+
- [ ] I have added tests that prove my fix is effective or that my feature works
121+
- [ ] New and existing unit tests pass locally with my changes
122+
- [ ] Any dependent changes have been merged and published
123+
124+
## AI Assistance Disclosure
125+
126+
- [ ] This PR was created entirely by a human
127+
- [ ] This PR was created with AI assistance
128+
129+
**If AI-assisted, please provide details**:
130+
- **AI Tool**: [e.g., Claude Code, GitHub Copilot]
131+
- **Scope of AI Assistance**: [e.g., "Code refactoring suggestions", "Test generation", "Documentation writing"]
132+
- **Human Review**: [Describe how you reviewed and validated the AI-generated content]
133+
134+
**Note**: Per AI_POLICY.md, you (the human) are the sole author of this contribution.
135+
AI assistance is acknowledged but does not constitute co-authorship.
136+
137+
## Additional Notes
138+
139+
[Any additional context, concerns, or discussion points]

0 commit comments

Comments
 (0)