From 2725db1595f72f175d4a8853c8cfb2d6aeab2179 Mon Sep 17 00:00:00 2001
From: hiento09 <136591877+hiento09@users.noreply.github.com>
Date: Wed, 30 Aug 2023 16:55:27 +0700
Subject: [PATCH] Chore: Add contributing.md file and update readme.md (#17)

Co-authored-by: Hien To <>
---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 README.md       | 36 ++++++++++++++++++++++++++++++++++--
 2 files changed, 66 insertions(+), 2 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..6ea90e69c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing to jan
+
+First off, thank you for considering contributing to jan. It's people like you that make jan such an amazing project.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/janhq/jan/issues).
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/janhq/jan/issues/new).
+
+### Suggesting Enhancements
+
+- Open a new issue with a clear title and description.
+
+### Your First Code Contribution
+
+- Fork the repo.
+- Create a new branch (`git checkout -b feature-name`).
+- Commit your changes (`git commit -am 'Add some feature'`).
+- Push to the branch (`git push origin feature-name`).
+- Open a new Pull Request.
+
+## Styleguides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature").
+
+## Additional Notes
+
+Thank you for contributing to jan!
\ No newline at end of file
diff --git a/README.md b/README.md
index f1d7858fd..eccba9932 100644
--- a/README.md
+++ b/README.md
@@ -81,8 +81,14 @@ docker compose up -d
 | app-backend (hasura) | http://localhost:8080 | Admin credentials are set via the environment variables `HASURA_GRAPHQL_ADMIN_SECRET` in file `conf/sample.env_app-backend`                                          |
 | web-client           | http://localhost:3000 | Users are signed up to keycloak, default created user is set via `conf/keycloak_conf/example-realm.json` on keycloak with username: `username`, password: `password` |
 | llm service          | http://localhost:8000 |                                                                                                                                                                      |
+## Usage
 
-After all service up and running, just access to `web-client` via `http://localhost:3000`, login with default user (username: `username`, password: `password`) and test the llm model with `chatgpt` session.
+To get started with Jan, follow these steps:
+
+1. Install the platform as per the instructions above.
+2. Launch the web application via `http://localhost:3000`.
+3. Login with default user (username: `username`, password: `password`)
+4. Test the llm model with `chatgpt` session
 
 ## Developers
 
@@ -111,4 +117,30 @@ Jan is a monorepo that pulls in the following submodules
 
 ## Live Demo
 
-You can access the live demo at https://cloud.jan.ai.
\ No newline at end of file
+You can access the live demo at https://cloud.jan.ai.
+
+## Common Issues and Troubleshooting
+
+**Error in `jan-inference` service** ![](images/download-model-error.png)
+
+- Error: download model incomplete
+- Solution:
+  - Manually download the LLM model using the URL specified in the environment variable `MODEL_URL` within the `.env` file. The URL is typically https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGML/resolve/main/llama-2-7b-chat.ggmlv3.q4_1.bin
+  - Copy the downloaded file `llama-2-7b-chat.ggmlv3.q4_1.bin` to the folder `jan-inference/llm/models`
+  - Run `docker compose down` followed by `docker compose up -d` again to restart the services.
+
+## Contributing
+
+Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.
+
+## License
+
+This project is licensed under the Fair Code License. See [LICENSE.md](LICENSE.md) for more details.
+
+## Authors and Acknowledgments
+
+Created by jan. Thanks to all contributors who have helped to improve this project.
+
+## Support and Contact
+
+For support or to report issues, please email support@jan.ai.