Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willydouhard authored May 15, 2023
1 parent dd1c2c8 commit 06dd30f
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ poetry install

## Contribute to the UI

The source code of the UI is in [src/chainlit/frontend](src/chainlit/frontend).
The source code of the UI is in [src/chainlit/frontend](/src/chainlit/frontend).

Before anything, go to [src/chainlit/frontend/api/index.ts](src/chainlit/frontend/api/index.ts). Find the definition of `const server` and inverse the comment:
Before anything, go to [src/chainlit/frontend/api/index.ts](/src/chainlit/frontend/src/api/index.ts). Find the definition of `const server` and inverse the comment:

```ts
// export const server = 'http://127.0.0.1:8000';
export const server = '';
export const server = 'http://127.0.0.1:8000';
// export const server = '';
```

Don't forget to revert that change before pushing.
Expand Down Expand Up @@ -93,7 +93,3 @@ The `-h` parameter (headless) means the UI will not automatically open. Only use
2. Run `npm test`

Once you create a pull request, the tests will automatically run. It is a good practice to run the tests locally before pushing.




0 comments on commit 06dd30f

Please sign in to comment.