|
| 1 | + |
| 2 | +## Meta |
| 3 | +**Name:** Extend RFC Template with Related RFCs and AffectedComponent Fields |
| 4 | + |
| 5 | +**Start Date:** 2025-01-23 |
| 6 | + |
| 7 | +**Author(s):** @beyhan |
| 8 | + |
| 9 | +**Status:** Draft |
| 10 | + |
| 11 | +**RFC Pull Request:** (fill in with PR link after you submit it) |
| 12 | + |
| 13 | +## Summary |
| 14 | +This RFC proposes extending the current Cloud Foundry RFC template with two additional metadata fields: `Related RFCs` and `Affected Component(s)`. These fields will improve traceability between related proposals and make it easier to identify which Cloud Foundry components are affected by a given RFC. |
| 15 | + |
| 16 | + |
| 17 | +## Problem |
| 18 | +The current RFC template lacks structured fields for capturing relationships between RFCs and identifying affected Cloud Foundry components. This makes it difficult to: |
| 19 | + |
| 20 | +- Understand dependencies or relationships between proposals |
| 21 | +- Quickly identify which teams or components need to review a given RFC |
| 22 | +- Search and filter RFCs by affected component |
| 23 | +- Understand the broader context of a proposal without reading the full document |
| 24 | + |
| 25 | +## Proposal |
| 26 | +The current Meta section of the RFC template should be extended with two additional fields: |
| 27 | + |
| 28 | +**Current template:** |
| 29 | +```markdown |
| 30 | +Meta |
| 31 | +Name: (fill in the feature name: My Feature) |
| 32 | +Start Date: (fill in today's date: YYYY-MM-DD) |
| 33 | +Author(s): (GitHub usernames) |
| 34 | +Status: Draft |
| 35 | +RFC Pull Request: (fill in with PR link after you submit it) |
| 36 | +``` |
| 37 | + |
| 38 | +**Proposed template:** |
| 39 | +```markdown |
| 40 | +Meta |
| 41 | +Name: (fill in the feature name: My Feature) |
| 42 | +Start Date: (fill in today's date: YYYY-MM-DD) |
| 43 | +Author(s): (GitHub usernames) |
| 44 | +Status: Draft |
| 45 | +RFC Pull Request: (fill in with PR link after you submit it) |
| 46 | +Related RFCs: (links to related or dependent RFCs) |
| 47 | +Affected Component(s): (affected Cloud Foundry components e.g., Diego, Gorouter) |
| 48 | +``` |
| 49 | + |
| 50 | +### Field Definitions |
| 51 | + |
| 52 | +**Related RFCs** |
| 53 | +- This field MUST contain links to any RFCs that are directly related or dependent on this proposal |
| 54 | +- This field MAY be left empty if no related RFCs exist |
| 55 | +- Multiple RFCs SHOULD be listed as a comma separated list of links |
| 56 | + |
| 57 | +**AffectedComponent(s)** |
| 58 | +- This field MUST list all Cloud Foundry components affected by the proposal |
| 59 | +- This field SHOULD reference the official component names as used in the Cloud Foundry GitHub organization |
| 60 | +- Multiple components SHOULD be listed as a comma separated list |
0 commit comments