Fediverse Enhancement Proposals (FEP) A common place for people to create drafts and follow lightweight rules for documenting technical details for other developers. Also see: https://socialhub.activitypub.rocks
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7.2 KiB

authors status dateReceived
pukkamustard <pukkamustard@posteo.net> DRAFT 2020-10-16

FEP-a4edc7b: The Fediverse Enhancement Proposal Process

Summary

A Fediverse Enhancement Proposal (FEP) is a document that provides information to the Fediverse community. The goal of a FEP is to improve interoperability and well-being of diverse services, applications and communities that form the Fediverse.

This document describes the scope, format and process of publishing Fediverse Enhancement Proposals.

Scope and Objectives

A Fediverse Enhancement Proposal (FEP) should be a concise and focused documentation of a specific topic that is of interest to the Fediverse community.

A proposal should always have the intention of improving the interoperability and well-being of diverse services, applications and community of the Fediverse.

The Fediverse includes applications, services and communities using the ActivityPub protocol and other protocols that foster decentralized and diverse social media and culture.

Proposals may include descriptions of technical protocols and mechanism, documentation of experimental work or current best practices.

Proposals are not limited to technical topics and may focus on social and cultural aspects.

Proposals may be entertaining and humorous (unlike this proposal).

Language, Document Structure and Format

All Fediverse Enhancement Proposals must be written in English, be properly formatted as CommonMark [CommonMark] and be reasonably grammatical.

Authors should use inclusive language and examples and refrain from using oppressive terminology [Internet-Draft-terminology-00].

Proposal Title and Identifier

Every Fediverse Enhancement Proposals must have a descriptive title.

An identifier is computed from the proposal title as the first 7 digits of the sha256 hash (in hex). The identifier can be computed from the title with standard Unix tools:

$ echo -n "The Fediverse Enhancement Proposal Process" | sha256sum | cut -c-7
a4edc7b

By using the hash of the title as identifier we reduce the burden on editors to assign unique ids. This require proposal titles to be unique.

Metadata

Proposal metadata is placed at the top of the document as key-value pairs between opening and closing ~---~.

Following metadata key-value pairs may be placed at the top of a proposal:

  • authors: A comma separated list of authors of the proposal.
  • status: Indicates the proposal status. Can be either DRAFT, WITHDRAWN or FINAL.
  • 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).
  • relatedFeps: A comma separated list of related FEPs (e.g. FEP-a4edc7b, FEP-141a22e, FEP-686f746).

Future FEPs may specify additional metadata fields.

Required Sections

Every FEP should include at least following sections:

  • Summary: A short (no more than 200 words) summary of the proposal.
  • Copyright: Indicating that the proposal has been placed in the public domain.

Following sections may be included in a proposal:

  • History: An overview of previous related efforts and how they relate to the proposal.
  • Implementations: If applicable an overview of services or applications that implement the proposal at time of submission.
  • References: A list of documents and resources referenced by the proposal.

Fediverse Enhancement Proposals must be placed in the public domain by the authors with a CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

The Fediverse Enhancement Proposals Process

                                     +-------+
                           +-------> | FINAL | 
                           |         +-------+
         +-------+         |
-------->| DRAFT | --------+
         +-------+         |
             ^             |         +-----------+
             |             +-------> | WITHDRAWN |
             |                       +-----------+
             |                             |
             +-----------------------------+
  1. A Fediverse Enhancement Proposal can be submitted by individuals or groups of individuals (authors) by creating a pull request to the FEP repository.
  2. Within seven days one of the editors will read and respond to the proposal. The editor checks if the proposal conforms to the required structure and fits the scope and objective of the FEPs. The editor may request the authors to clarify, justify, or withdraw the proposal. Such a request must not reflect the personal bias of an editor. Rather, it will be made strictly to maintain a high quality of submissions. The editors 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 editor approves a submission it receives the status DRAFT and is added to the repository.
  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 an editor.
    • Authors may withdraw the submission upon which an editor will set the status of the submission to WITHDRAWN.
  5. After at least 60 days the authors may request the proposal to be finalized. This is done by requesting final comments on the proposal.
    • If there are no community objections within 14 days and the authors can show that they have initiated sufficient awareness and discussion of the proposal, an editor will set the status of the submission to FINAL.
  6. If after 90 days the authors have not requested the proposal to be finalized or there is no community consensus, an editor will set the status of the submission to WITHDRAWN.
  7. A proposal with status FINAL can not be changed or updated.
  8. A proposal with status WITHDRAWN remains in the repository and can be resubmitted.

History

The process and format described in this proposal is influenced by other community driven documentation efforts such as the BitTorrent Enhancment Proposal Process [BEP-1], Scheme Request for Implementation [SRFI] and the IETF RFC Series [RFC-8729].

References

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

To the extent possible under law, the authors of this Fediverse Enhancement Proposal have waived all copyright and related or neighboring rights to this work.