a
d3cd04d8a8
as discussed in https://socialhub.activitypub.rocks/t/fep-a4ed-the-fediverse-enhancement-proposal-process/1171/38?u=trwnh onward, and as described in https://socialhub.activitypub.rocks/t/fep-a4ed-the-fediverse-enhancement-proposal-process/1171/57?u=trwnh Open considerations: 1. This PR copies `feps/fep-xxxx.md` to `fep/xxxx/fep-xxxx.md` for now. There is some consideration for naming it `index.md` instead, in order to ease with potential future static site generation via CI/CD. Imagine a CI/CD task that clones the repo and generates a proper site using `fep` as the content directory. (The idea is that this site may then be served to anyone requesting text/html representations of the `https://w3id.org/fep/xxxx` URI following the specifications laid out in FEP-9606.) 2. This PR does not yet delete any old paths. Everything in `feps/` has been edited to contain a Markdown link to the new location. Rationale: - We have encountered FEPs that wish to create their own assets, and the current structure is confusingly laid out. Asset colocation is widely considered a "best practice" for this sort of scenario. Particularly in cases where the rest of the repo's structure may potentially change in the future, asset colocation prevents any FEP-specific links from breaking because those links can be written relative to their FEP root. - To ease PURL resolution, context documents can be considered sidecar assets to each FEP that defines extension terms. The mechanism for this is again described in FEP-9606. Redirection rules can be simplified to use less conditions, since the base folder remains the same. Next steps: - Edit the README.md to update the instructions for submitting a new FEP (pending open consideration 1) - Set a timeline for when or if the old `feps/` directory should be removed (pending open consideration 2) - Merge this PR Co-authored-by: a <a@trwnh.com> Reviewed-on: https://codeberg.org/fediverse/fep/pulls/109 Co-authored-by: a <trwnh@noreply.codeberg.org> Co-committed-by: a <trwnh@noreply.codeberg.org>
Fediverse Enhancement Proposals
This is the Git repository containing Fediverse Enhancment Proposals (FEPs).
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.
The FEP Process is an initiative of the SocialHub developer community, a liaison of the W3C Social Web Incubator Community Group. For ongoing and past discussion see the SocialHub FEP category.
FEPs
Submitting a FEP
Do you have an idea, opinion or information that you want to share with the wider Fediverse community? You may do so with a Fediverse Enhancement Proposal (FEP).
To create and submit a FEP:
- Fork this repository, and then clone it to your local machine. Check the Codeberg Cheat sheet on how to prepare your Pull Request.
- Think of a title for the FEP you want to submit.
- Compute the identifier of the FEP by computing the hash of the title. This can be done with following Unix command:
$ echo -n "The title of my proposal" | sha256sum | cut -c-4
b3f0
- Create a subdirectory of
fep/(fep/) using the identifier you just computed. Copy the FEP template (fep-xxxx-template.md) to this subdirectory and change the filename appropriately. Use the identifer as the "slug" when filling out the frontmatter. For example, if your computed identifier wasabcd, then your file would be located atfep/abcd/fep-abcd.mdand your frontmatter would includeslug: "abcd". - Write down your idea in the newly created file and commit it to a new branch in your repository (ex. fep-xxxx).
- Create a Pull Request to complete Step 1 of FEP-a4ed: The Fediverse Enhancement Proposal Process. Further process is described in FEP-a4ed.
Editors
The list of FEP's is facilitated by Editors who are listed in the EDITORS.md file. Editors are neutral custodians of the FEP process, who merge PR's, create tracking issues, and start discussion threads for each FEP in the SocialHub developer community forum.
Contributing
Do you have ideas to improve the FEP Process? Post your suggestions to the issue tracker, or on the SocialHub forum. The SocialHub developer community is a "DoOcracy" which means: “pick up any task you want, and then steer it to completion”. Your contributions are most welcome, so delve in and find out how you can help.
License
CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
To the extent possible under law, the authors of this document have waived all copyright and related or neighboring rights to this work.