From c367767a899a1471f6e468f804eb43091396db5a Mon Sep 17 00:00:00 2001
From: Andrei Fajardo <92402603+nerdai@users.noreply.github.com>
Date: Wed, 20 Mar 2024 23:29:35 -0400
Subject: [PATCH] chore: Add instructions for filling in the README when
 creating new extension packages (#12134)

* info about README

* update our PR template

* typo
---
 .github/pull_request_template.md |  7 +++++++
 CONTRIBUTING.md                  | 10 ++++++++--
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index fc19ed43a..fe51ee994 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -4,6 +4,13 @@ Please include a summary of the change and which issue is fixed. Please also inc
 
 Fixes # (issue)
 
+## New Package?
+
+Did I fill in the `tool.llamahub` section in the `pyproject.toml` and provide a detailed README.md for my new integration or package?
+
+- [ ] Yes
+- [ ] No
+
 ## Version Bump?
 
 Did I bump the version in the `pyproject.toml` file of the package I am updating? (Except for the `llama-index-core` package)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 648562592..d80321b7f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -49,7 +49,10 @@ llamaindex-cli new-package --kind "llms" --name "gemini"
 Executing the above commands will create a new folder called `llama-index-llms-gemini`
 within the `llama-index-integrations/llms` directory.
 
-In addition to preparing your source code, we also ask that you fill in some
+Please ensure to add a detailed README for your new package as it will appear in
+both [llamahub.ai](https://llamahub.ai) as well as the PyPi.org website.
+In addition to preparing your source code and supplying a detailed README, we
+also ask that you fill in some
 metadata for your package to appear in [llamahub.ai](https://llamahub.ai) with the
 correct information. You do so by adding the required metadata under the `[tool.llamahub]`
 section with your new package's `pyproject.toml`.
@@ -314,7 +317,10 @@ Executing the first set of shell commands will create a new folder called `llama
 within the `llama-index-packs` directory. While the second set will create a new
 package directory called `llama-index-readers-new-reader` within the `llama-index-integrations/readers` directory.
 
-In addition to preparing your source code, we also ask that you fill in some
+Please ensure to add a detailed README for your new package as it will appear in
+both [llamahub.ai](https://llamahub.ai) as well as the PyPi.org website.
+In addition to preparing your source code and supplying a detailed README, we
+also ask that you fill in some
 metadata for your package to appear in [llamahub.ai](https://llamahub.ai) with the
 correct information. You do so by adding the required metadata under the `[tool.llamahub]`
 section with your new package's `pyproject.toml`.
-- 
GitLab