Skip to content

Commit f11c713

Browse files
committed
Convert CHANGELOG.md to AsciiDoc
1 parent 9694a58 commit f11c713

1 file changed

Lines changed: 250 additions & 0 deletions

File tree

CHANGELOG.adoc

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

0 commit comments

Comments
 (0)