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
+31-6
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,38 @@
2
2
# Contributing to openaps
3
3
4
4
Thanks for being a part of openaps.
5
+
6
+
OpenAPS is a series of tools to support a self-driven DIY
7
+
implementation based on the OpenAPS reference design. The tools may be
8
+
categorized as *monitor* (collecting data about environment, and
9
+
operational status of devices and/or aggregating as much data as is
10
+
relevant into one place), *predict* (make predictions about what should
11
+
happen next), or *control* (enacting changes, and feeding more data back
12
+
into the *monitor*).
13
+
14
+
By proceeding using these tools or any piece within, you agree to the
15
+
copyright (see LICENSE.txt for more information) and release any
16
+
contributors from liability.
17
+
18
+
*Note:* This is intended to be a set of tools to support a self-driven DIY
19
+
implementation and any person choosing to use these tools is solely
20
+
responsible for testing and implement these tools independently or
21
+
together as a system. The [DIY part of OpenAPS is important]
22
+
(http://bit.ly/1NBbZtO). While formal training or experience as an
23
+
engineer or a developer is not required, what *is* required is a growth
24
+
mindset to learn what are essentially "building blocks" to implement an
25
+
OpenAPS instance. This is not a "set and forget" system; it requires
26
+
diligent and consistent testing and monitoring to ensure each piece of
27
+
the system is monitoring, predicting, and performing as desired. The
28
+
performance and quality of your system lies solely with you.
29
+
30
+
Additionally, this community of contributors believes in "paying it
31
+
forward", and individuals who are implementing these tools are asked to
32
+
contribute by asking questions, helping improve documentation, and
33
+
contribute in other ways.
34
+
5
35
Please submit issues and pull requests so that all users can share
6
-
knowledge.
36
+
knowledge. If you're unfamiliar with GitHub and/or coding, [check out these other ways to get involved with OpenAPS.](https://openaps.gitbooks.io/building-an-open-artificial-pancreas-system/content/docs/Overview/contribute.html)
7
37
8
38
For hacking on openaps, here are some tips to help your patches reach
9
39
more people more quickly. The `master` branch is special, it should
@@ -21,10 +51,5 @@ Here's few guidelines that might help:
21
51
* Avoid editing `master` branch.
22
52
* test changes
23
53
24
-
That's it for now, thanks again!
25
-
After several successful pull requests, @bewest, @openaps and others
26
-
might add you as contributor so you can create shared branches more
27
-
easily.
28
-
29
54
See [OpenAPS.org](http://OpenAPS.org/) for background on the OpenAPS movement and project.
0 commit comments