Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avie66 authored Dec 18, 2024
1 parent dd8a6f6 commit 76ab0c2
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
11. After that, you can test the chat functionality with latest features.

0 comments on commit 76ab0c2

Please sign in to comment.