From ee86d5febbb143a2c447216dc9c8c8e72a9e4483 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sim=C3=B3n=20Fishman?= Date: Thu, 12 Oct 2023 16:57:03 -0700 Subject: [PATCH] Reorganize contribution materials (#783) --- {project => .github}/registry_schema.json | 0 project/rubric.md => CONTRIBUTING.md | 6 +++--- registry.yaml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) rename {project => .github}/registry_schema.json (100%) rename project/rubric.md => CONTRIBUTING.md (99%) diff --git a/project/registry_schema.json b/.github/registry_schema.json similarity index 100% rename from project/registry_schema.json rename to .github/registry_schema.json diff --git a/project/rubric.md b/CONTRIBUTING.md similarity index 99% rename from project/rubric.md rename to CONTRIBUTING.md index 0b8b7166..28c6331b 100644 --- a/project/rubric.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Rubric +# Welcome, AI Chef The OpenAI Cookbook is a community-driven resource aimed at sharing knowledge in a way that is accessible, engaging, and enriching for everyone. To ensure the quality of submissions, we have established a rubric that assesses each contribution on various areas. @@ -8,7 +8,7 @@ We encourage contributors to familiarize themselves with this rubric before writ For additional guidelines on writing good documentation, refer to [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good). -## Template +## Rubric | Criteria | Score | | ----------------------------- | ----- | @@ -20,7 +20,7 @@ For additional guidelines on writing good documentation, refer to [What Makes Do | Usability | | | Completeness | | -## Breakdown +### Breakdown #### Relevance diff --git a/registry.yaml b/registry.yaml index 2f8fb393..fbb24cc5 100644 --- a/registry.yaml +++ b/registry.yaml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=./admin/registry_schema.json +# yaml-language-server: $schema=./.github/registry_schema.json # This file is used to generate cookbook.openai.com. It specifies which paths we # should build pages for, and indicates metadata such as tags, creation date and