Skip to content

Conversation

j9o
Copy link
Owner

@j9o j9o commented Jun 15, 2023

Pull Request (PR) Checklist

If you'd like to contribute, please follow the checklist below when submitting a PR. This will help us review and merge your changes faster! Thank you for contributing!

  1. Type of PR: Indicate the type of PR by adding a label in square brackets at the beginning of the title, such as [Bugfix], [Feature], [Enhancement], [Refactor], or [Documentation].

  2. Short Description: Provide a brief, informative description of the PR that explains the changes made.

  3. Issue(s) Linked: Mention any related issue(s) by using the keyword Fixes or Closes followed by the respective issue number(s) (e.g., Fixes upsert-file endpoint accepts metadata openai/chatgpt-retrieval-plugin#123, Closes Update LICENSE, fix copyright license year openai/chatgpt-retrieval-plugin#456).

  4. Branch: Ensure that you have created a new branch for the changes, and it is based on the latest version of the main branch.

  5. Code Changes: Make sure the code changes are minimal, focused, and relevant to the issue or feature being addressed.

  6. Commit Messages: Write clear and concise commit messages that explain the purpose of each commit.

  7. Tests: Include unit tests and/or integration tests for any new code or changes to existing code. Make sure all tests pass before submitting the PR.

  8. Documentation: Update relevant documentation (e.g., README, inline comments, or external documentation) to reflect any changes made.

  9. Review Requested: Request a review from at least one other contributor or maintainer of the repository.

  10. Video Submission (For Complex/Large PRs): If your PR introduces significant changes, complexities, or a large number of lines of code, submit a brief video walkthrough along with the PR. The video should explain the purpose of the changes, the logic behind them, and how they address the issue or add the proposed feature. This will help reviewers to better understand your contribution and expedite the review process.

Pull Request Naming Convention

Use the following naming convention for your PR branches:

<type>/<short-description>-<issue-number>
  • <type>: The type of PR, such as bugfix, feature, enhancement, refactor, or docs. Multiple types are ok and should appear as ,
  • <short-description>: A brief description of the changes made, using hyphens to separate words.
  • <issue-number>: The issue number associated with the changes made (if applicable).

Example:

feature/advanced-chunking-strategy-123

egor-romanov and others added 19 commits May 15, 2023 08:34
* add supabase + pgvector datastore provider

* fix conflicts: move supabase docs from readme

* add supabase to unused deps doc

* add supabase local setup docs and tests

* small improvements in setup.md

* add pure postgres implementation and more tests

* add postgres datastore docs to readme

* rebase to latest main

* fix typo in readme - postgres envs

* add some indexes and pgvector idx strategy in docs

* enable RLS by default
* Update README.md

* Update README.md
The text in the postgres section specifically called out supabase, but pgvector is available on many vendors

this points directly to the pgvector repo so that users can choose
* UPgraded fastapi and redis to fix security vulnerabilities

* Could not justify fastapi upgrade
* Add a full PostgresSQL syntax distributed database AnalyticDB as a datastore.

* Replace psycopg2 with psycopg2cffi to compatibility with Python >=3.10 and Refactor AnalyticDB related ENV

* Change the `psycopg2cfii` package to optional and update setup.md with PostgreSQL dependency installation instructions

* Use a connection pool to replace connect with the PostgreSQl vector store directly. To prevent connection lost problem.

* Modify READEME. Add `analyticdb` into `DATASTORE`
* Add loguru for logging

* Add logger

* Replace exception with error

---------

Co-authored-by: Raghu Ganapathi <[email protected]>
* add PR checklist for contributions

* add PR checklist template
@j9o j9o merged commit 2940a94 into j9o:main Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.