Skip to content

Commit

Permalink
authorGitHubIds -> contributorGitHubIds
Browse files Browse the repository at this point in the history
  • Loading branch information
mshibanami committed May 14, 2024
1 parent bc3b0eb commit ffb31d0
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 11 deletions.
6 changes: 4 additions & 2 deletions docs/library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ This file contains metadata of a rule set.

```json
{
"authorGitHubId": "<your-github-id>",
"contributorGitHubIds": [
"<your-github-id>"
],
"imageFiles": [
"image.png"
],
Expand All @@ -73,7 +75,7 @@ This file contains metadata of a rule set.
}
```

- `authorGitHubId`: An author's GitHub ID.
- `contributorGitHubIds`: An array of contributors' GitHub IDs, sorted by the date they were involved in the rule.
- `aboutURL` (optional): A link to a webpage where users can learn more about the rule set.
- `title`: A short title of the rule set.
- `description`: A description of the rule set. This is optional when the first rule in the rule set has non-empty `comments`.
Expand Down
4 changes: 3 additions & 1 deletion docs/library/rule-sets/0_example-rule/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"title": "Example Redirect Rule",
"description": "An example rule.",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"cover.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"cover.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"title": "Wikipedia: Open in Wikiwand",
"description": "Open Wikipedia pages in Wikiwand automatically.",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"cover.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"cover.png"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"title": "Google Search: From Video Tab to YouTube's Search Results",
"description": "This redirects from the Videos tab on Google Search to the search results on YouTube automatically.",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"cover.jpg"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"authorGitHubId": "mshibanami",
"contributorGitHubIds": [
"mshibanami"
],
"aboutURL": null,
"imageFiles": [
"screenshot.jpg"
Expand Down

0 comments on commit ffb31d0

Please sign in to comment.