First of all, thank you for taking some of your time to contribute to the project. You're awesome 🦆👍
- Get started
- Run the tests
- Run it locally
- Open a PR and add acknowledge your contribution
- Other Commands
- Clone the repo:
git clone [email protected]:srikanth235/privy.git - Go into the cloned repository:
cd privy - Install dependencies:
pnpm install - Build the extension:
pnpm build-all
The project uses TypeScript, Vitest for the tests and Prettier for the formatting.
You can run tests with pnpm test
To run them in watch mode, use: pnpm test-watch.
You can use VS Code's built-in debugger on the project to try out your local extension.
To build the project, press F5. It should run the run - app/vscode task.
This will:
- Build the project
- Open a new "Extension Development Host" VS Code window, with your local code overriding your "Privy" extension
It's handy to test your changes in integration with VS Code API.
- VS Code Extension API documentation is a good start
- OpenAI API documentation is also useful if you plan to change the prompts
Style formatting is managed by Prettier. It runs as a pre-commit hook, so you shouldn't have to worry about it 👐
You can open a Pull-Request at any time. It can even be a draft if you need to ask for guidance and help. Actually, we'd be pretty happy to assist you going in the best direction!
Once everything is ready, open a Pull-Request (if it's not already done) and ask for a review. We'll do our best to review it asap.
Finally, use all-contributors bot command to add yourself to the list of contributors. It's very easy to do, you basically need to mention the bot in a comment of your PR.
Whether it's code, design, typo or documentation, every contribution is welcomed! So again, thank you very, very much 🦆
-
You can find a brief introduction to the architecture of this extension here.
-
You can find more info about adding AI Chat templates here.
- Lint:
pnpm nx lint --skip-nx-cache - Package:
pnpm nx run vscode:package