Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.46 KB

CONTRIBUTING.md

Annotations

OpenAI API Reference

OpenAI Documentation

Adding New Models

  • Identify the model name with a request to GET https://api.openai.com/v1/models
  • Make sure the model supports the API you're interested in using (see Model endpoint compatibility here)
  • Modify the command, currently in ./lua/explain-it/services/chat-gpt.lua, to use the model of interest
  • Make sure you are parsing the response correctly (should work out of the box if you are using the chat or completions APIs)

Testing Local Config

Often times you will have the published version of the explain-it.nvim plugin installed via the package manager used on your local system, but you will want to test or run the code in your local repo. The Makefile has two scripts to help facilitate this:

  • make run
  • make test

These ensure that the local version is used along with a minimal config for a sandboxed test/run environment

Settings

Execute this command to view current settings: :lua =ExplainIt.config