From 76ab0c2e4dd8746292abffa4fc09c0d5209f415b Mon Sep 17 00:00:00 2001 From: Awantika Date: Wed, 18 Dec 2024 16:09:14 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1a8681d..cb2c0926 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,26 @@ -# refact-intellij & refact-chat-js -### Instructions for React Chat build for JetBrains IDEs (to run locally) +# 🌟 Contribute to refact-intellij & refact-chat-js + +## 📚 Table of Contents +- [❤️ Ways to Contribute](#%EF%B8%8F-ways-to-contribute) + - [🐛 Report Bugs](#-report-bugs) +- [Instructions for React Chat build for JetBrains IDEs (to run locally)](#-instructions-for-react-chat-build-for-jetbrains-ides-to-run-locally) + + +### ❤️ Ways to Contribute + +* Fork the repository +* Create a feature branch +* Do the work +* Create a pull request +* Maintainers will review it + + +### 🐛 Report Bugs +Encountered an issue? Help us improve Refact.ai by reporting bugs in issue section, make sure you label the issue with correct tag [here](https://github.com/smallcloudai/refact-intellij/issues)! + + + +### 🔨 Instructions for React Chat build for JetBrains IDEs (to run locally) 1. Clone the branch alpha of the repository `refact-chat-js`. 2. Install dependencies and build the project: ```bash @@ -13,4 +34,4 @@ 8. Start the project by right-clicking on the command `refact-intellij [runIde]`. 9. Inside the Refact.ai settings in the new IDE (PyCharm will open), select the field `Secret API Key` and press the key combination `Ctrl + Alt + - (minus)`, if using MacOS: `Command + Option + - (minus)`. 10. Scroll down and insert the port value for `xDebug LSP port`, which is the port under which LSP is running locally. By default, LSP's port is `8001`. -11. After that, you can test the chat functionality with latest features. \ No newline at end of file +11. After that, you can test the chat functionality with latest features.