1
0
mirror of https://codeberg.org/fediverse/fep.git synced 2026-08-08 21:45:52 +00:00

Update scripts documentation (#155)

Improving documentation:
- The necessary API token scope is `write:issue`
- Removed the sentence about issue URL since it's not actually required for creating SocialHub topic.
- Other minor edits.

Reviewed-on: https://codeberg.org/fediverse/fep/pulls/155
Co-authored-by: silverpill <silverpill@firemail.cc>
Co-committed-by: silverpill <silverpill@firemail.cc>
This commit is contained in:
silverpill
2023-09-06 17:59:44 +00:00
committed by silverpill
parent 6e916394e2
commit 9a5b2626e7
+5 -6
View File
@@ -11,16 +11,15 @@ and note the slug.
python scripts/create_issue.py $SLUG
```
creates the tracking issue and updates the fep with the information.
This script prints the issue url, you will need it later to add the
link to the SocialHub discussion. Then run
creates the tracking issue and updates the FEP with the information.
Then run
```bash
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 `discussionsTo` to frontmatter) and README.md,
added the new FEP.
Run
@@ -32,7 +31,7 @@ python scripts/create_topic.py $SLUG
and following the instructions to create a topic on SocialHub to discuss
the FEP.
Finally, add the link to the SocialHub issue to the tracking issue, created above.
Finally, add the link to the SocialHub topic to the tracking issue, created above.
## Configuration
@@ -46,7 +45,7 @@ Add a file `config.json` to the directory `scripts` with content
}
```
The API token can be obtained by visiting [https://codeberg.org/user/settings/applications](https://codeberg.org/user/settings/applications) and generating one with scope "public_repo".
The API token can be obtained by visiting [https://codeberg.org/user/settings/applications](https://codeberg.org/user/settings/applications) and generating one with scope `write:issue`.
## Setup for running pytest