Skip to content

Commit 0bbe48c

Browse files
committed
Add Contributing.md
1 parent 55dc238 commit 0bbe48c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

Contributing.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Ollama-GUI-Chat
2+
3+
## Reporting an Issue
4+
5+
You can report an issue thru GitHub [issues](https://github.com/tomteipl/Ollama-GUI-Chat/issues).
6+
7+
Include as much information as possible, like:
8+
9+
* Version of the app
10+
* Your OS
11+
* Steps to reproduce the issue
12+
* Overall description of the issue
13+
14+
## Improving the App
15+
16+
Feel free to fork the project and make changes.
17+
Python modules used in repo are:
18+
19+
* [`customtkinter`](https://customtkinter.tomschimansky.com/)
20+
* [`requests`](https://pypi.org/project/requests/)
21+
* [`tkinter`](https://docs.python.org/3/library/tkinter.html) - should be installed by default
22+
* [`os`](https://docs.python.org/3/library/os.html) - should be installed by default
23+
* [`json`](https://docs.python.org/3/library/json.html) - should be installed by default
24+
25+
Remember to comment your new code as much as possible.
26+
It will help others to understand your changes.
27+
28+
Next, create a [pull request](https://github.com/tomteipl/Ollama-GUI-Chat/pulls)
29+
with your changes.
30+
Include a description of your changes, why you made them
31+
and how they work.
32+
33+
>[!IMPORTANT]
34+
>Windows and Linux versions have to be as similar as possible.
35+
>If you are able to test your changes on both systems, it would be great.
36+
37+
### Thank you
38+
39+
I really appreciate your help in improving the app.
40+
Thank you for considering contributing to [Ollama-GUI-Chat]!
41+
Im grateful for the support of this community and
42+
encourage contributions from everyone.

0 commit comments

Comments
 (0)