Skip to content

Latest commit

 

History

History
110 lines (66 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

110 lines (66 loc) · 3.18 KB

Contributing to Sirji

Thank you for your interest in contributing to Sirji, a VS Code Extension that aims to enhance your coding experience. This guide is designed to help you set up your environment for contributing to Sirji and its components, including the associated PyPI packages.

Prerequisites

Make sure you have installed all of the following prerequisites on your machine:

  • Visual Studio Code (>= 1.80.2)
  • Node.js (>= 18) and npm (>= 8.19)
  • Python (>= 3.10) - Make sure python --version runs without error.
  • tee command - Make sure which tee runs without error.

To check whether your machine meets these prerequisites, run:

sh check_prerequisites.sh

Also, you will need an OpenAI API key.

Contributing to VS Code Extension

1. Clone the Repository

First, clone the Sirji repository to your local machine using the following command:

git clone [email protected]:sirji-ai/sirji.git

2. Navigate to the Extension Directory

Once the repository is cloned, switch to the VS Code Extension directory:

cd sirji/vscode-extension

3. Open the Project in VS Code

Open the folder in Visual Studio Code by running:

code .

4. Local PyPI Packages

Update src/py_scripts/requirements.txt with the following content, to use the local editable installations of the PyPI packages:

urllib3==1.25.11
-e {{absolute path to cloned sirji repo}}/messages
-e {{absolute path to cloned sirji repo}}/agents

5. Install Dependencies

Install the project dependencies:

npm install

7. Compile TypeScript

Compile the TypeScript code to JavaScript:

npm run watch

8. Run Sirji in Debug Mode

To start debugging the extension and see your changes in action, follow these steps:

  • Open the Run and Debug View

    • You can open this view from the Activity Bar on the left side of the window or by using the shortcut Cmd+Shift+D.

  • Select Debug Configuration

    • From the dropdown menu at the top of the Run and Debug view, select the Run Extension option.

  • Start Debugging

    • Press the Start Debugging button (the green play icon) to launch a new VS Code window (Extension Development Host) where the extension will be loaded.

9. Activating Sirji

To activate the extension in the Extension Development Host:

  • Open the Command Palette with Cmd+Shift+P, type Sirji, and press Enter.

Now the Sirji chat interface should open, allowing you to interact with Sirji via the chat.

Contributing to the PyPI Packages

To contribute to one of the PyPI packages (sirji-agents, sirji-messages, sirji-tools), please refer to the instructions provided in the respective README files within their directories:

Questions or Issues?

If you run into any issues or have suggestions, please report them by following our issue reporting guidelines. Your reports help us make Sirji better for everyone.

Thank you for considering contributing to Sirji. Happy coding!