https://github.com/xp-framework/rfc
One of the major deficiencies in the development of many projects is that there is no roadmap or strategy available other than in the developers' heads. The XP team publishes its decisions by documenting change requests in form of RFCs.
https://github.com/xp-framework/rfc
Last synced: 10 months ago
JSON representation
One of the major deficiencies in the development of many projects is that there is no roadmap or strategy available other than in the developers' heads. The XP team publishes its decisions by documenting change requests in form of RFCs.
- Host: GitHub
- URL: https://github.com/xp-framework/rfc
- Owner: xp-framework
- Created: 2011-10-17T14:27:22.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2011-10-17T18:37:25.000Z (about 14 years ago)
- Last Synced: 2025-01-20T19:22:26.727Z (12 months ago)
- Homepage:
- Size: 161 KB
- Stars: 2
- Watchers: 18
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
XP: RFC README
========================================================================
This document describes the RFC procedure.
What is an RFC?
---------------
RFC stands for Request For Comments, but you knew that:)
When is an RFC needed?
----------------------
An RFC is needed when changes are made that affect one of the following:
* Core functionality (e.g., in `lang.base.php`)
* Classes in the `lang` package or subpackages thereof
* Wherever it affects a lot of places, e.g. `xml.Node`
* When **BC** (backwards compatibility) is broken
Changes include any type of change except for QA work or bug fixes.
Who can write RFCs?
-------------------
Short answer: Anybody. Simply open an issue [here](https://github.com/xp-framework/rfc/issues)
What does an RFC look like?
---------------------------
An RFC is a GitHub issue with a special inline format defined by the
following template:
```
Scope of Change
==
Rationale
==
Functionality
==
Security considerations
==
Speed impact
==
Dependencies
==
Related documents
==
```