Skip to content

Commit

Permalink
docs: add looking for maintainers section (#382)
Browse files Browse the repository at this point in the history
Co-authored-by: winston <[email protected]>
  • Loading branch information
sgoudham and nekowinston authored Dec 17, 2023
1 parent af364af commit 2c967fe
Show file tree
Hide file tree
Showing 11 changed files with 137 additions and 380 deletions.
4 changes: 0 additions & 4 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
/styles/brave-search @ndsboy
/styles/bstats @rockquiet
/styles/canvas-lms @TheMemeSniper
/styles/chatgpt @rubyowo
/styles/chatreplay @AnubisNekhet
/styles/chess.com @coldenate @isabelroses @skelebro1
/styles/cinny @jn-sena
Expand All @@ -15,7 +14,6 @@
/styles/ecosia @isabelroses
/styles/elk @ryanccn
/styles/formative @r58Playz
/styles/github @Pocco81 @GlowingUmbreon
/styles/gmail @isabelroses
/styles/google @GitMuslim
/styles/hacker-news @lucasmelin
Expand All @@ -34,12 +32,10 @@
/styles/nitter @AnubisNekhet
/styles/nixos-search @alaidriel
/styles/nixos.wiki @nekowinston
/styles/paste.rs @Stonks3141
/styles/pinterest @jn-sena
/styles/planet-minecraft @night-lake
/styles/proton @soya-daizu
/styles/quizlet @spaghettiosareyummy
/styles/reddit @jayylmao
/styles/searxng @Sekki21956 @ryanccn
/styles/spotify-web @tnixc
/styles/startpage @bartlibert
Expand Down
436 changes: 93 additions & 343 deletions deno.lock

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions scripts/generate/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ await syncIssueLabels(userstylesData.userstyles);
await updateFile(
join(REPO_ROOT, ".github/CODEOWNERS"),
Object.entries(userstylesData.userstyles)
.filter(([_, { readme }]) => readme["current-maintainers"].length > 0)
.map(([slug, { readme }]) => {
const currentMaintainers = readme["current-maintainers"]
.map((maintainer) => `@${maintainer.url.split("/").pop()}`)
Expand Down
5 changes: 5 additions & 0 deletions scripts/generate/templates/userstyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,15 @@
{{/each}}
{{/if}}

{{#if collaborators.currentMaintainers.length}}
## πŸ’ Current {{pluralize collaborators.currentMaintainers 'Maintainer'}}
{{#each collaborators.currentMaintainers}}
- [{{name}}]({{url}})
{{/each}}
{{else}}
## 🚧 Looking for Maintainers 🚧
- If you are interested in maintaining this userstyle, please raise a **Pull Request** and add yourself into the `current-maintainers` array in the `userstyles.yml` file.
{{/if}}

{{#if collaborators.pastMaintainers}}
## πŸ’– Past {{pluralize collaborators.pastMaintainers 'Maintainer'}}
Expand Down
25 changes: 8 additions & 17 deletions scripts/types/userstyles.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,23 +79,6 @@ export type Question = string;
* An answer to the question about the userstyle.
*/
export type Answer = string;
/**
* List of all active maintainers for this userstyle.
*
* @minItems 1
*/
export type CurrentMaintainers = [
{
name?: DisplayName;
url: GitHubProfile;
[k: string]: unknown;
},
...{
name?: DisplayName;
url: GitHubProfile;
[k: string]: unknown;
}[]
];
/**
* The display name of the collaborator to show in the userstyle README.
*/
Expand All @@ -104,6 +87,14 @@ export type DisplayName = string;
* The GitHub profile link of the collaborator to show in the userstyle README.
*/
export type GitHubProfile = string;
/**
* List of all active maintainers for this userstyle.
*/
export type CurrentMaintainers = {
name?: DisplayName;
url: GitHubProfile;
[k: string]: unknown;
}[];
/**
* List of all maintainers that have maintained on this userstyle in the past.
*
Expand Down
6 changes: 5 additions & 1 deletion scripts/userstyles.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,14 @@
"$id": "#userstyles/userstyle/readme/current-maintainers",
"title": "Current Maintainers",
"description": "List of all active maintainers for this userstyle.",
"type": "array",
"$ref": "#/$defs/collaborators"
},
"past-maintainers": {
"$id": "#userstyles/userstyle/readme/past-maintainers",
"title": "Past Maintainers",
"type":"array",
"minItems": 1,
"description": "List of all maintainers that have maintained on this userstyle in the past.",
"$ref": "#/$defs/collaborators"
}
Expand All @@ -153,14 +156,15 @@
"$id": "#all-collaborators",
"title": "All Collaborators",
"description": "Represents all maintainers and contributors to all userstyles.",
"type": "array",
"minItems": 1,
"$ref": "#/$defs/collaborators"
}
},
"$defs": {
"collaborators": {
"$id": "#collaborators",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
Expand Down
13 changes: 8 additions & 5 deletions scripts/userstyles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ userstyles:
category: productivity
readme:
app-link: "https://chat.openai.com"
current-maintainers: [*rubyowo]
current-maintainers: []
past-maintainers: [*rubyowo]
chatreplay:
name: ChatReplay
category: leisure
Expand Down Expand Up @@ -217,8 +218,8 @@ userstyles:
readme:
usage: "Switch to a default GitHub light/dark theme via **Settings** > **Appearance** for the best experience!"
app-link: "https://github.com"
current-maintainers: [*pocco81, *glowingumbreon]
past-maintainers: [*andreasgrafen]
current-maintainers: []
past-maintainers: [*andreasgrafen, *pocco81, *glowingumbreon]
gmail:
name: Gmail
category: productivity
Expand Down Expand Up @@ -368,7 +369,8 @@ userstyles:
category: development
readme:
app-link: "https://paste.rs"
current-maintainers: [*stonks3141]
current-maintainers: []
past-maintainers: [*stonks3141]
pinterest:
name: Pinterest
category: social
Expand Down Expand Up @@ -405,7 +407,8 @@ userstyles:
icon: reddit
readme:
app-link: "https://reddit.com"
current-maintainers: [*jayylmao]
current-maintainers: []
past-maintainers: [*jayylmao]
searxng:
name: SearXNG
category: search_engine
Expand Down
6 changes: 4 additions & 2 deletions styles/chatgpt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@



## πŸ’ Current Maintainer
- [rubyowo](https://github.com/rubyowo)
## 🚧 Looking for Maintainers 🚧
- If you are interested in maintaining this userstyle, please raise a **Pull Request** and add yourself into the `current-maintainers` array in the `userstyles.yml` file.

## πŸ’– Past Maintainer
- [rubyowo](https://github.com/rubyowo)

&nbsp;

Expand Down
9 changes: 5 additions & 4 deletions styles/github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,13 @@
Switch to a default GitHub light/dark theme via **Settings** > **Appearance** for the best experience!


## πŸ’ Current Maintainers
- [Pocco81](https://github.com/Pocco81)
- [Umbreon](https://github.com/GlowingUmbreon)
## 🚧 Looking for Maintainers 🚧
- If you are interested in maintaining this userstyle, please raise a **Pull Request** and add yourself into the `current-maintainers` array in the `userstyles.yml` file.

## πŸ’– Past Maintainer
## πŸ’– Past Maintainers
- [Andreas Grafen](https://github.com/andreasgrafen)
- [Pocco81](https://github.com/Pocco81)
- [Umbreon](https://github.com/GlowingUmbreon)

&nbsp;

Expand Down
6 changes: 4 additions & 2 deletions styles/paste.rs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@



## πŸ’ Current Maintainer
- [Stonks3141](https://github.com/Stonks3141)
## 🚧 Looking for Maintainers 🚧
- If you are interested in maintaining this userstyle, please raise a **Pull Request** and add yourself into the `current-maintainers` array in the `userstyles.yml` file.

## πŸ’– Past Maintainer
- [Stonks3141](https://github.com/Stonks3141)

&nbsp;

Expand Down
6 changes: 4 additions & 2 deletions styles/reddit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@



## πŸ’ Current Maintainer
- [jayylmao](https://github.com/jayylmao)
## 🚧 Looking for Maintainers 🚧
- If you are interested in maintaining this userstyle, please raise a **Pull Request** and add yourself into the `current-maintainers` array in the `userstyles.yml` file.

## πŸ’– Past Maintainer
- [jayylmao](https://github.com/jayylmao)

&nbsp;

Expand Down

0 comments on commit 2c967fe

Please sign in to comment.