From 17f6c4a5e4fc519643e64db5d71e4232ca52fdaa Mon Sep 17 00:00:00 2001 From: simonpfish Date: Tue, 7 Nov 2023 16:19:59 -0800 Subject: [PATCH] add authors yaml --- .github/authors_schema.json | 25 +++++++++++++++++++++++ .github/pull_request_template.md | 2 +- authors.yaml | 34 ++++++++++++++++++++++++++++++++ 3 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 .github/authors_schema.json create mode 100644 authors.yaml diff --git a/.github/authors_schema.json b/.github/authors_schema.json new file mode 100644 index 00000000..c977da83 --- /dev/null +++ b/.github/authors_schema.json @@ -0,0 +1,25 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "patternProperties": { + "^.*$": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "website": { + "type": "string", + "format": "uri" + }, + "avatar": { + "type": "string", + "format": "uri" + } + }, + "required": ["name", "website", "avatar"], + "additionalProperties": false + } + }, + "additionalProperties": false +} diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 95dfebfc..57dda79f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,7 +12,7 @@ Why are these changes necessary? How do they improve the cookbook? When contributing new content, read through our [contribution guidelines](https://github.com/openai/openai-cookbook/blob/main/CONTRIBUTING.md), and mark the following action items as completed: -- [ ] I have added a new entry in [registry.yaml](/registry.yaml) so that my content renders on the cookbook website. +- [ ] I have added a new entry in [registry.yaml](/registry.yaml) (and, optionally, in [authors.yaml](/authors.yaml)) so that my content renders on the cookbook website. - [ ] I have conducted a self-review of my content based on the [contribution guidelines](https://github.com/openai/openai-cookbook/blob/main/CONTRIBUTING.md#rubric): - [ ] Relevance: This content is related to building with OpenAI technologies and is useful to others. - [ ] Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation. diff --git a/authors.yaml b/authors.yaml new file mode 100644 index 00000000..7ad68f08 --- /dev/null +++ b/authors.yaml @@ -0,0 +1,34 @@ +# yaml-language-server: $schema=./.github/authors_schema.json + +# You can optionally customize how your information shows up cookbook.openai.com over here. +# If your information is not present here, it will be pulled from your GitHub profile. + +0hq: + name: "Will Depue" + website: "http://depue.design" + avatar: "https://pbs.twimg.com/profile_images/1619879636057595904/NdjEAqPm_400x400.jpg" + +cathykaic: + name: "Kai Chen" + website: "https://twitter.com/cathykaic" + avatar: "https://pbs.twimg.com/profile_images/1657816900817272832/ioGq5O0t_400x400.jpg" + +shyamal-anadkat: + name: "Shyamal Anadkat" + website: "https://twitter.com/shyamalanadkat" + avatar: "https://pbs.twimg.com/profile_images/1590564338682560512/3bbZJqxZ_400x400.jpg" + +simonpfish: + name: "Simón Fishman" + website: "https://twitter.com/simonpfish" + avatar: "https://pbs.twimg.com/profile_images/1687643030243901441/61DpxNfc_400x400.jpg" + +joe-at-openai: + name: "Joe Palermo" + website: "https://www.linkedin.com/in/joe-palermo-99219237" + avatar: "https://media.licdn.com/dms/image/C4E03AQF_tsi7Kom0rg/profile-displayphoto-shrink_800_800/0/1630002100665?e=1704931200&v=beta&t=z3HKO9FmGHJIxhes9TXRzw-8iY-CBsEZYZc8zTogiLU" + +mwu1993: + name: "Michael Wu" + website: "https://www.linkedin.com/in/michael-wu-77440977/" + avatar: "https://media.licdn.com/dms/image/C5603AQFhQfx0I-raUg/profile-displayphoto-shrink_800_800/0/1527451059977?e=1704931200&v=beta&t=wkFOj0Rigp6e9wm7aZdziOQ6jHARyXj3EoK1K8jaaas"