Skip to content

Commit 16d0ded

Browse files
Jonathan D.A. Jewellclaude
andcommitted
chore: sync template files and configuration
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent e6e7e28 commit 16d0ded

3 files changed

Lines changed: 543 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
# Changelog
2+
3+
**SPDX-License-Identifier: MIT OR AGPL-3.0-or-later**
4+
5+
All notable changes to vext will be documented in this file.
6+
7+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
8+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
10+
## [Unreleased]
11+
12+
### Added
13+
- RSR (Rhodium Standard Repository) compliance framework
14+
- Comprehensive documentation suite (README, INSTALLATION, USAGE, FEATURES)
15+
- Palimpsest dual licensing (MIT OR AGPL-3.0-or-later)
16+
- Tri-Perimeter Contribution Framework (TPCF) governance
17+
- RFC 9116 compliant `.well-known/security.txt`
18+
- AI training policy (`.well-known/ai.txt`)
19+
- Team attribution (`.well-known/humans.txt`)
20+
- Automated RSR compliance checker (`tools/rsr_checker.py`)
21+
- Nix flakes for reproducible builds (`flake.nix`)
22+
- justfile for build automation
23+
- GitLab CI/CD configuration
24+
- Comprehensive security policy (SECURITY.md)
25+
- Code of Conduct with emotional safety framework
26+
- Contribution guidelines (CONTRIBUTING.md)
27+
- Maintainer documentation (MAINTAINERS.md)
28+
29+
### Changed
30+
- Forked from irker to vext (Rhodium Standard Edition)
31+
- Modernized documentation structure
32+
- Enhanced security policies and procedures
33+
- Improved governance model
34+
35+
### Deprecated
36+
- (None yet)
37+
38+
### Removed
39+
- (None yet)
40+
41+
### Fixed
42+
- (None yet)
43+
44+
### Security
45+
- Implemented comprehensive security.txt (RFC 9116)
46+
- Added vulnerability disclosure process
47+
- Defined security review procedures
48+
49+
## [1.0.0] - 2025-01-01
50+
51+
### Added
52+
- Initial release of vext (Rhodium Standard Edition)
53+
- Fork from irker with modernization focus
54+
- Complete documentation overhaul
55+
- RSR Bronze level compliance achieved
56+
- RSR Silver level compliance achieved
57+
- Community governance framework (TPCF)
58+
- Automated build and testing infrastructure
59+
- Security-first design principles
60+
61+
### Changed
62+
- Rebranded from irker to vext
63+
- Updated all documentation to modern standards
64+
- Enhanced configuration options
65+
- Improved error handling and logging
66+
67+
## [0.1.0] - 2025-01-01
68+
69+
### Added
70+
- Initial fork from irker
71+
- Basic project structure
72+
- Core IRC notification functionality
73+
- Multi-VCS support (Git, Mercurial, SVN)
74+
- JSON protocol support
75+
- TCP and UDP communication
76+
- Rate limiting and flood prevention
77+
- Connection pooling
78+
- Multi-channel broadcasting
79+
- Color formatting support
80+
81+
### Technical Debt
82+
- Documentation needs modernization
83+
- Security policies need formalization
84+
- Build system needs standardization
85+
- Governance model needs definition
86+
87+
---
88+
89+
## Version History Summary
90+
91+
| Version | Date | Significance | RSR Level |
92+
| ------- | ---------- | ------------ | --------- |
93+
| 1.0.0 | 2025-01-01 | Initial release with RSR compliance | Silver |
94+
| 0.1.0 | 2025-01-01 | Fork from irker | None |
95+
96+
## Release Notes Archive
97+
98+
Detailed release notes for each version are available in `docs/releases/`:
99+
- [v1.0.0 Release Notes](docs/releases/v1.0.0.md)
100+
101+
## Migration Guides
102+
103+
### From irker to vext
104+
105+
See [docs/migration/FROM_IRKER.md](docs/migration/FROM_IRKER.md) for detailed migration instructions.
106+
107+
**Quick Summary**:
108+
- vext is backward-compatible with irker configuration
109+
- No breaking changes in core functionality
110+
- Enhanced features are opt-in
111+
- Migration is primarily documentation and governance updates
112+
113+
**Key Differences**:
114+
- Modernized documentation
115+
- Formal security policies
116+
- Governance framework
117+
- Reproducible builds
118+
- CI/CD automation
119+
120+
## Compatibility Matrix
121+
122+
| vext Version | Python Version | Supported VCS | IRC Servers |
123+
| ------------ | -------------- | ------------- | ----------- |
124+
| 1.0.0 | 3.6+ | Git, Hg, SVN | RFC 1459 |
125+
| 0.1.0 | 3.6+ | Git, Hg, SVN | RFC 1459 |
126+
127+
## Deprecation Policy
128+
129+
We follow a gradual deprecation process:
130+
131+
1. **Announcement**: Feature marked as deprecated in changelog
132+
2. **Warning Period**: Minimum 2 minor versions or 6 months
133+
3. **Deprecation**: Feature issues warnings when used
134+
4. **Removal**: Feature removed in next major version
135+
136+
### Current Deprecations
137+
- (None)
138+
139+
### Planned Deprecations
140+
- (None)
141+
142+
## Security Updates
143+
144+
Security updates are released as soon as fixes are available and tested.
145+
146+
### Security Advisories
147+
148+
| Date | Severity | CVE | Description | Fixed In |
149+
| ---------- | -------- | --- | ----------- | -------- |
150+
| (None yet) | - | - | - | - |
151+
152+
See [SECURITY.md](SECURITY.md) for vulnerability disclosure process.
153+
154+
## Breaking Changes
155+
156+
We avoid breaking changes whenever possible. When necessary, they are:
157+
- Documented in detail
158+
- Announced at least one major version in advance
159+
- Include migration guides
160+
- Provide backward compatibility shims when feasible
161+
162+
### Major Version Breaking Changes
163+
164+
**2.0.0** (Future):
165+
- (None planned yet)
166+
167+
**1.0.0**:
168+
- Repository rename: irker → vext
169+
- License change: BSD-2-Clause → MIT OR AGPL-3.0-or-later (Palimpsest)
170+
- Note: Both are permissive; users can choose MIT for backward compatibility
171+
172+
## Contribution Credits
173+
174+
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for full list of contributors.
175+
176+
### Major Contributors by Version
177+
178+
**1.0.0**:
179+
- [Lead Maintainer] - Project lead, RSR compliance, documentation
180+
- [Core Developer 1] - IRC protocol, network layer
181+
- [Core Developer 2] - Build systems, CI/CD
182+
183+
**0.1.0**:
184+
- Eric S. Raymond - Original irker author
185+
186+
## Release Channels
187+
188+
### Stable
189+
- **Version**: 1.0.0
190+
- **Support**: Full support with security updates
191+
- **Recommended For**: Production use
192+
193+
### Development
194+
- **Branch**: `main`
195+
- **Stability**: May contain breaking changes
196+
- **Recommended For**: Testing, early adopters
197+
198+
### Long-Term Support (LTS)
199+
- **Version**: (None yet)
200+
- **Support**: Extended security and bug fix support
201+
- **Recommended For**: Enterprise deployments
202+
203+
## Changelog Maintenance
204+
205+
This changelog is:
206+
- **Updated**: With every release
207+
- **Format**: [Keep a Changelog](https://keepachangelog.com/)
208+
- **Versioning**: [Semantic Versioning](https://semver.org/)
209+
- **Maintained By**: Release managers (see [MAINTAINERS.md](MAINTAINERS.md))
210+
211+
## Comparison with Upstream (irker)
212+
213+
| Feature | irker | vext | Notes |
214+
| ------- | ----- | ---- | ----- |
215+
| Core IRC functionality ||| Fully compatible |
216+
| Multi-VCS support ||| Git, Hg, SVN |
217+
| JSON protocol ||| Identical |
218+
| Documentation | Basic | Comprehensive | Major improvement |
219+
| Security policies | Informal | Formal | RFC 9116 compliant |
220+
| Build system | Basic | Modern | Nix, just, CI/CD |
221+
| Governance | None | TPCF | Formal framework |
222+
| Testing | Limited | Comprehensive | Automated testing |
223+
| RSR compliance | None | Silver | Structured standards |
224+
225+
## Historical Context
226+
227+
**vext** is a modernized fork of **irker** by Eric S. Raymond:
228+
- **Original Project**: https://gitlab.com/esr/irker
229+
- **Fork Date**: 2025-01-01
230+
- **Fork Reason**: Active maintenance, comprehensive documentation, modern standards
231+
- **Compatibility**: Full backward compatibility with irker
232+
- **Acknowledgment**: We thank Eric S. Raymond for creating irker
233+
234+
## Future Roadmap
235+
236+
See [docs/roadmap/ROADMAP.md](docs/roadmap/ROADMAP.md) for detailed future plans.
237+
238+
**Upcoming**:
239+
- 1.1.0: Enhanced monitoring and metrics
240+
- 1.2.0: Additional IRC protocol extensions (SASL, TLS)
241+
- 2.0.0: Architectural improvements, potential breaking changes
242+
243+
---
244+
245+
**Changelog Maintained By**: Release Team
246+
**Last Updated**: 2025-01-01
247+
**Format Version**: 1.0.0 (Keep a Changelog)
248+
249+
For questions about releases, contact: release@vext.dev

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
See [CONTRIBUTING.adoc](CONTRIBUTING.adoc) for full contribution guidelines.

0 commit comments

Comments
 (0)