OLD | NEW |
1 gae: A Google AppEngine SDK wrapper designed for testing+extensibility (for Go) | 1 gae: A Google AppEngine SDK wrapper designed for testing+extensibility (for Go) |
2 =================== | 2 =================== |
3 | 3 |
4 [](https://godoc.org/g
ithub.com/luci/gae) | 4 [](https://godoc.org/g
ithub.com/luci/gae) |
5 [](https://trav
is-ci.org/luci/gae) | 5 [](https://trav
is-ci.org/luci/gae) |
6 [](https://coveralls.io/github/luci/gae?branch=master) | 6 [](https://coveralls.io/github/luci/gae?branch=master) |
7 | 7 |
8 | |
9 Installing | 8 Installing |
10 ---------- | 9 ---------- |
11 | 10 |
12 go get -u github.com/luci/gae/... | 11 go get -u github.com/luci/gae/... |
13 | 12 |
| 13 Why/What/How |
| 14 ------------ |
14 | 15 |
15 Code layout | 16 See the [godocs](https://godoc.org/github.com/luci/gae). |
16 ----------- | |
17 | |
18 * This directory contains the interfaces common to all supported services. | |
19 * [/dummy/...](https://github.com/luci/gae/tree/master/dummy) | |
20 Contains dummy service implementations (they just panic, not too interesting
). | |
21 * [/prod/...](https://github.com/luci/gae/tree/master/prod) | |
22 Contains service implementations based on the [Appengine SDK](google.golang.
org/appengine/datastore). | |
23 * [/memory/...](https://github.com/luci/gae/tree/master/memory) | |
24 Contains fast, in-memory service implementations for testing. | |
25 * [/filters/...](https://github.com/luci/gae/tree/master/filters) | |
26 Contains optional service filters to transparently change the behavior | |
27 of the services. Can be used with any service implementation. | |
28 * [/helper/...](https://github.com/luci/gae/tree/master/helper) contains | |
29 methods for doing helpful reflection, binary serialization, etc. You | |
30 don't have to worry about these too much, but they're there if you need | |
31 them for doing lower-level things (like building new service implementations | |
32 or filters). | |
33 | |
34 | 17 |
35 Versioning | 18 Versioning |
36 ---------- | 19 ---------- |
37 | 20 |
38 * Branch `master` constains the latest code. | 21 * Branch `master` constains the latest code. |
39 | 22 |
40 | |
41 Contributing | 23 Contributing |
42 ------------ | 24 ------------ |
43 | 25 |
44 * Sign the [Google CLA](https://cla.developers.google.com/clas). | 26 * Sign the [Google CLA](https://cla.developers.google.com/clas). |
45 * Make sure your `user.email` and `user.name` are configured in `git config`. | 27 * Make sure your `user.email` and `user.name` are configured in `git config`. |
46 * Install the [pcg](https://github.com/maruel/pre-commit-go) git hook: | 28 * Install the [pcg](https://github.com/maruel/pre-commit-go) git hook: |
47 `go get -u github.com/maruel/pre-commit-go/cmd/... && pcg` | 29 `go get -u github.com/maruel/pre-commit-go/cmd/... && pcg` |
48 | 30 |
49 Run the following to setup the code review tool and create your first review: | 31 Run the following to setup the code review tool and create your first review: |
50 | 32 |
51 git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $
HOME/src/depot_tools | 33 git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $
HOME/src/depot_tools |
52 export PATH="$PATH:$HOME/src/depot_tools" | 34 export PATH="$PATH:$HOME/src/depot_tools" |
53 cd $GOROOT/github.com/luci/gae | 35 cd $GOROOT/github.com/luci/gae |
54 git new-branch work | 36 git new-branch work |
55 # or `git checkout -b work origin/master` if you like typing more. | 37 # or `git checkout -b work origin/master` if you like typing more. |
56 | 38 |
57 # hack hack | 39 # hack hack |
58 | 40 |
59 git commit -a -m "This is awesome\nR=joe@example.com" | 41 git commit -a -m "This is awesome\nR=joe@example.com" |
60 # This will ask for your Google Account credentials. | 42 # This will ask for your Google Account credentials. |
61 git cl upload -s | 43 git cl upload -s |
62 # Wait for LGTM over email. | 44 # Wait for LGTM over email. |
63 git cl land | 45 git cl land |
64 | 46 |
65 Use `git cl help` and `git cl help <cmd>` for more details. | 47 Use `git cl help` and `git cl help <cmd>` for more details. |
OLD | NEW |