You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+57-6
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,6 @@ Thank you for your interest in contributing to Ollama! Here are a few guidelines
6
6
7
7
See the [development documentation](./docs/development.md) for instructions on how to build and run Ollama locally.
8
8
9
-
## Pull requests
10
-
11
9
### Ideal issues
12
10
13
11
*[Bugs](https://github.com/ollama/ollama/issues?q=is%3Aissue+is%3Aopen+label%3Abug): issues where Ollama stops working or where it results in an unexpected error.
@@ -26,11 +24,64 @@ See the [development documentation](./docs/development.md) for instructions on h
26
24
* Changes that add significant friction to the user experience
27
25
* Changes that create a large future maintenance burden for maintainers and contributors
28
26
29
-
### Best practices
27
+
## Proposing a (non-trivial) change
28
+
29
+
> By "non-trivial", we mean a change that is not a bug fix or small
30
+
> documentation update. If you are unsure, please ask us on our [Discord
31
+
> server](https://discord.gg/ollama).
32
+
33
+
Before opening a non-trivial Pull Request, please open an issue to discuss the change and
34
+
get feedback from the maintainers. This helps us understand the context of the
35
+
change and how it fits into Ollama's roadmap and prevents us from duplicating
36
+
work or you from spending time on a change that we may not be able to accept.
37
+
38
+
Tips for proposals:
39
+
40
+
* Explain the problem you are trying to solve, not what you are trying to do.
41
+
* Explain why the change is important.
42
+
* Explain how the change will be used.
43
+
* Explain how the change will be tested.
44
+
45
+
Additionally, for bonus points: Provide draft documentation you would expect to
46
+
see if the change were accepted.
47
+
48
+
## Pull requests
49
+
50
+
**Commit messages**
51
+
52
+
The title should look like:
53
+
54
+
<package>: <shortdescription>
55
+
56
+
The package is the most affected Go package. If the change does not affect Go
57
+
code, then use the directory name instead. Changes to a single well-known
58
+
file in the root directory may use the file name.
59
+
60
+
The short description should start with a lowercase letter and be a
61
+
continuation of the sentence:
62
+
63
+
"This changes Ollama to..."
64
+
65
+
Examples:
66
+
67
+
llm/backend/mlx: support the llama architecture
68
+
CONTRIBUTING: provide clairity on good commit messages, and bad
69
+
70
+
Bad Examples:
71
+
72
+
feat: add more emoji
73
+
fix: was not using famous web framework
74
+
chore: generify code
75
+
76
+
**Tests**
77
+
78
+
Please include tests. Strive to test behavior, not implementation.
79
+
80
+
**New dependencies**
30
81
31
-
* Commit messages: please leave both a title and a description in your commit messages. The title should be a short summary of the changes, with a leading word that explains the section of the code being changed (e.g. `api: fix parsing of prompt field`) . In the description, leave a short 2-3 sentences that explain more about the change and its impact.
32
-
* Tests: please add test coverage to changes where possible.
33
-
* Minimize dependencies: avoid adding new dependencies unless absolutely necessary.
82
+
Dependencies should be added sparingly. If you are adding a new dependency,
83
+
please explain why it is necessary and what other ways you attempted that
0 commit comments