1
0
mirror of https://codeberg.org/fediverse/fep.git synced 2026-08-05 19:55:46 +00:00
Files
fep/scripts/backmatter.md
T

50 lines
2.7 KiB
Markdown
Raw Normal View History

2023-07-16 07:43:02 +00:00
## 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:
1. Fork this repository, and then clone it to your local machine. Check the Codeberg [Cheat sheet](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/#cheat-sheet) on how to prepare your Pull Request.
2. Think of a title for the FEP you want to submit.
3. Compute the identifier of the FEP by computing the hash of the title. This can be done with following Unix command:
2023-10-27 13:42:33 +02:00
2023-07-16 07:43:02 +00:00
```
$ echo -n "The title of my proposal" | sha256sum | cut -c-4
b3f0
```
2023-10-27 13:42:33 +02:00
2023-07-19 14:40:31 +00:00
4. Create a subdirectory of [`fep/`](./fep/) using the identifier you just computed.
2023-07-16 07:43:02 +00:00
5. Copy the FEP template ([fep-xxxx-template.md](./fep-xxxx-template.md)) to this subdirectory and change the filename appropriately.
2023-10-27 13:42:33 +02:00
6. Use the identifer as the "slug" when filling out the frontmatter.
2023-07-16 07:43:02 +00:00
- For example, if your computed identifier was `abcd`, then your file would be located at `fep/abcd/fep-abcd.md` and your frontmatter would include `slug: "abcd"`.
7. Write down your idea in the newly created file and commit it to a new branch in your repository (ex. fep-xxxx).
8. When you are ready to submit the FEP, change the value of `dateReceived` field in the frontmatter to the current date.
9. Create a discussion topic for your FEP. You can use [ActivityPub category](https://socialhub.activitypub.rocks/c/activitypub/5) on the SocialHub forum.
10. Add `discussionsTo` field containing the URL of the discussion topic to the front matter of your FEP.
11. Create a Pull Request to complete Step 1 of [FEP-a4ed: The Fediverse Enhancement Proposal Process](./fep/a4ed/fep-a4ed.md). Further process is described in FEP-a4ed.
2023-07-16 07:43:02 +00:00
2023-10-27 13:42:33 +02:00
Alternatively to steps 3. to 6., you can run
```bash
python scripts/new_proposal.py TITLE OF YOUR PROPOSAL
```
that should create a prefilled template for you.
2024-04-09 19:48:55 +00:00
## Facilitators
2023-07-16 07:43:02 +00:00
The list of FEP's is maintained by the facilitators who are listed in the [FACILITATORS.md](FACILITATORS.md) file. Facilitators are neutral custodians of the FEP process, who merge PR's and create tracking issues.
2023-07-16 07:43:02 +00:00
## Contributing
Do you have ideas to improve the FEP Process? Post your suggestions to the issue tracker, or on the [SocialHub](https://socialhub.activitypub.rocks) 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.
2023-07-16 07:43:02 +00:00
## License
2023-10-27 13:42:33 +02:00
CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
2023-07-16 07:43:02 +00:00
To the extent possible under law, the authors of this document have waived all copyright and related or neighboring rights to this work.