From e928041c433d4392f8b0442c6b24022ceeb4ce7c Mon Sep 17 00:00:00 2001 From: silverpill Date: Fri, 17 May 2024 19:33:25 +0000 Subject: [PATCH] FEP-a4ed: Introduce trackingIssue metadata field (#284) This is the first PR for issue https://codeberg.org/fediverse/fep/issues/185 Once this change is approved and merged, I will add `trackingIssue` to all existing proposals. After that `discussionsTo` can be used for solving https://codeberg.org/fediverse/fep/issues/274. Reviewed-on: https://codeberg.org/fediverse/fep/pulls/284 Reviewed-by: Arnold Schrijver --- fep/a4ed/fep-a4ed.md | 6 ++++-- scripts/README.md | 2 +- scripts/create_issue.py | 4 ++++ 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/fep/a4ed/fep-a4ed.md b/fep/a4ed/fep-a4ed.md index a38f1e6..9163c70 100644 --- a/fep/a4ed/fep-a4ed.md +++ b/fep/a4ed/fep-a4ed.md @@ -4,6 +4,7 @@ authors: pukkamustard status: FINAL dateReceived: 2020-10-16 dateFinalized: 2021-01-18 +trackingIssue: https://codeberg.org/fediverse/fep/issues/201 discussionsTo: https://codeberg.org/fediverse/fep/issues/201 --- # FEP-a4ed: The Fediverse Enhancement Proposal Process @@ -58,7 +59,8 @@ Following metadata key-value pairs may be placed at the top of a proposal: - `dateReceived`: Date of when the proposal was added to the repository (when status is set to `DRAFT`). - `dateWithdrawn`: Date of when the proposal status was set to `WITHDRAWN` (only for proposals with status `WITHDRAWN`). - `dateFinalized`: Date of when the proposal status was set to `FINAL` (only for proposals with status `FINAL`). -- `discussionsTo`: Link to the tracking issue for the proposal. +- `trackingIssue`: Link to the tracking issue for the proposal. +- `discussionsTo`: Link to the discussion. - `relatedFeps`: A comma separated list of related FEPs (e.g. `FEP-a4ed, FEP-141a, FEP-686f`). - `replaces`: A comma separated list of FEPs that are replaced by the proposal. - `replacedBy`: Identifier of a FEP that replaces the proposal. @@ -98,7 +100,7 @@ Fediverse Enhancement Proposals must be placed in the public domain by the autho 1. A Fediverse Enhancement Proposal can be submitted by individuals or groups of individuals (authors). See the `SUBMISSION.md` file for a list of accepted submission methods. 2. Within seven days one of the facilitators will read and respond to the proposal. The facilitator checks if the proposal conforms to the required structure and fits the scope and objective of the FEPs. The facilitator may request the authors to clarify, justify, or withdraw the proposal. Such a request must not reflect the personal bias of a facilitator. Rather, it will be made strictly to maintain a high quality of submissions. The facilitators reserve the right to reject a submission when a proposal amounts to blatant misuse of the process. The authors may seek feedback from the wider community if the submitted proposal is rejected or clarifications are requested. -3. If a FEP Facilitator approves a submission it receives the status `DRAFT` and is added to the repository. The facilitator also creates a tracking issue for the proposal. +3. If a FEP facilitator approves a submission it receives the status `DRAFT` and is added to the repository. The facilitator also creates a tracking issue for the proposal and adds `trackingIssue` attribute to the proposal metadata. 4. While a proposal has the status `DRAFT`: - Authors are responsible for initiating community discussion and collecting feedback. - Authors may submit updates to the proposal which will be checked in to the repository by a facilitator. Others may also submit updates, but in this case a change must be approved by at least one author. diff --git a/scripts/README.md b/scripts/README.md index 3f63afb..70370cb 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -19,7 +19,7 @@ python scripts/create_readme.py ``` to update the table in `README.md`. You are now ready to commit the -changes to the FEP (added `discussionsTo` to frontmatter) and README.md, +changes to the FEP (added `trackingIssue` to frontmatter) and README.md, added the new FEP. Run diff --git a/scripts/create_issue.py b/scripts/create_issue.py index b58c696..4e8c3c4 100644 --- a/scripts/create_issue.py +++ b/scripts/create_issue.py @@ -13,6 +13,9 @@ args = parser.parse_args() fep_file = FepFile(args.fep) +if "trackingIssue" in fep_file.parsed_frontmatter: + print("File already has trackingIssue") + exit(1) if "discussionsTo" in fep_file.parsed_frontmatter: print("File already has discussionsTo") exit(1) @@ -54,6 +57,7 @@ response = urlopen(request) issue_url = json.loads(response.read())["html_url"] +fep_file.frontmetter.append(f"trackingIssue: {issue_url}") fep_file.frontmatter.append(f"discussionsTo: {issue_url}") fep_file.write()