Skip to content

Commit dab5c13

Browse files
committed
Update CONTRIBUTING.md
Tweaking a little bit for fresh eyes plus adding related language from the README work I've been doing today. cc @channemann @scottleibrand @bewest
1 parent 957f248 commit dab5c13

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

CONTRIBUTING.md

+31-6
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,38 @@
22
# Contributing to openaps
33

44
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+
535
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)
737

838
For hacking on openaps, here are some tips to help your patches reach
939
more people more quickly. The `master` branch is special, it should
@@ -21,10 +51,5 @@ Here's few guidelines that might help:
2151
* Avoid editing `master` branch.
2252
* test changes
2353

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-
2954
See [OpenAPS.org](http://OpenAPS.org/) for background on the OpenAPS movement and project.
3055

0 commit comments

Comments
 (0)