From a02a0ad36df92c10c8765c96a9c3d93b50359299 Mon Sep 17 00:00:00 2001
From: Simon Warta <simon@warta.it>
Date: Mon, 29 Jun 2020 08:37:32 +0200
Subject: [PATCH 1/3] Format some text files

---
 README.md                 | 3 ++-
 packages/sdk39/README.md  | 5 ++---
 packages/socket/README.md | 8 +++++---
 3 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index e37f214f..f6e2f345 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,8 @@ package; right depends on left):
 
 ![CosmJS dependency tree](docs/cosmjs-tree.png)
 
-If this was not enough to scare you away, check out the version including app runtime dependencies: [cosmjs-tree-full.png](docs/cosmjs-tree-full.png).
+If this was not enough to scare you away, check out the version including app
+runtime dependencies: [cosmjs-tree-full.png](docs/cosmjs-tree-full.png).
 
 <!--
 Build with depsight (https://github.com/webmaster128/depsight), using:
diff --git a/packages/sdk39/README.md b/packages/sdk39/README.md
index 87188a42..ba6d4456 100644
--- a/packages/sdk39/README.md
+++ b/packages/sdk39/README.md
@@ -6,7 +6,6 @@ A client library for the Cosmos SDK 0.39.
 
 ## License
 
-This package is part of the cosmjs repository, licensed under the Apache
-License 2.0 (see
-[NOTICE](https://github.com/CosmWasm/cosmjs/blob/master/NOTICE) and
+This package is part of the cosmjs repository, licensed under the Apache License
+2.0 (see [NOTICE](https://github.com/CosmWasm/cosmjs/blob/master/NOTICE) and
 [LICENSE](https://github.com/CosmWasm/cosmjs/blob/master/LICENSE)).
diff --git a/packages/socket/README.md b/packages/socket/README.md
index 114e32b3..c6e3ecbc 100644
--- a/packages/socket/README.md
+++ b/packages/socket/README.md
@@ -2,9 +2,11 @@
 
 [![npm version](https://img.shields.io/npm/v/@cosmjs/socket.svg)](https://www.npmjs.com/package/@cosmjs/socket)
 
-@cosmjs/socket is a collection of helper methods and classes for working with WebSockets.
+@cosmjs/socket is a collection of helper methods and classes for working with
+WebSockets.
 
 ## License
 
-This package is part of the cosmjs repository, licensed under the Apache License 2.0
-(see [NOTICE](https://github.com/CosmWasm/cosmjs/blob/master/NOTICE) and [LICENSE](https://github.com/CosmWasm/cosmjs/blob/master/LICENSE)).
+This package is part of the cosmjs repository, licensed under the Apache License
+2.0 (see [NOTICE](https://github.com/CosmWasm/cosmjs/blob/master/NOTICE) and
+[LICENSE](https://github.com/CosmWasm/cosmjs/blob/master/LICENSE)).

From 3f03c0a937a8279de5e7a2c3dcd6ac359012a949 Mon Sep 17 00:00:00 2001
From: Simon Warta <simon@warta.it>
Date: Mon, 29 Jun 2020 09:04:41 +0200
Subject: [PATCH 2/3] Rewrite development instructions in HACKING.md

---
 HACKING.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md  | 28 +------------------
 2 files changed, 83 insertions(+), 27 deletions(-)
 create mode 100644 HACKING.md

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 00000000..c7266eaf
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,82 @@
+# Hacking CosmJS
+
+Welcome to CosmJS, glad to see you here. This document explains all you need to
+work on CosmJS, i.e. modify it. It is not intended for users of CosmJS.
+
+## Prerequisite
+
+- A UNIX-like development environment
+- Node.js 10+, Docker and yarn
+- `sha256sum`, which you
+  [can get on macOS as well](https://unix.stackexchange.com/questions/426837/no-sha256sum-in-macos)
+
+## Checking out code
+
+We use Git for version control. In addition to the well-known basics, we use the
+extension Git Large File Storage (LFS) to store blobs (currently \*.png and
+\*.wasm). A git-lfs package is available directly in modern package repositories
+(Debian 10+, Ubuntu 18.04+, Homebrew, MacPorts) and as a backport for older
+systems. Please see [this website](https://git-lfs.github.com/) for instructions
+how to install it.
+
+If you installed git-lfs after cloning this repo, use this command to replace
+the links with the original files: `git lfs checkout`.
+
+To verify everything worked as expected, check if the testing contracts are
+correctly checked out:
+
+```sh
+cd scripts/wasmd/contracts
+sha256sum -c checksums.sha256
+```
+
+## Running tests
+
+For unit tests that don't connect to any blockchain, just do:
+
+```sh
+yarn install
+yarn test
+```
+
+To run the entire test suite, you need to run some local blockchain to test
+against. We use [wasmd](https://github.com/CosmWasm/wasmd) for both CosmWasm
+tests and as a generic Cosmos SDK 0.38 blockchain. We also spawn multiple
+versions of raw Tendermint and a basic WebSocket server.
+
+```sh
+# Start wasmd
+./scripts/wasmd/start.sh
+./scripts/wasmd/init.sh
+export WASMD_ENABLED=1
+
+# Start Tendermint
+./scripts/tendermint/all_start.sh
+export TENDERMINT_ENABLED=1
+
+# Start WebSocket server
+./scripts/socketserver/start.sh
+export SOCKETSERVER_ENABLED=1
+
+# now more tests are running that were marked as "pending" before
+yarn test
+
+# And at the end of the day
+unset SOCKETSERVER_ENABLED
+unset TENDERMINT_ENABLED
+unset WASMD_ENABLED
+./scripts/socketserver/stop.sh
+./scripts/tendermint/all_stop.sh
+./scripts/wasmd/stop.sh
+```
+
+## Sanity
+
+After you modified a file, check if the linter is happy:
+
+```sh
+yarn lint
+
+# or if you want liniting plus automatic fixing
+yarn lint-fix
+```
diff --git a/README.md b/README.md
index f6e2f345..b643bbb5 100644
--- a/README.md
+++ b/README.md
@@ -68,30 +68,4 @@ a higher level roadmap
 
 ## Development
 
-Requires Node 10+. For best results, use yarn. The basic commands are:
-
-```sh
-yarn install
-
-# compile the code
-yarn build
-# run unit tests
-yarn test
-
-# format and lint the code
-yarn format && yarn lint
-```
-
-### Integration tests
-
-To run the entire test suite, you need to run a local blockchain to test
-against. We use [wasmd](https://github.com/CosmWasm/wasmd) for both CosmWasm
-tests and as a generic Cosmos SDK 0.38 blockchain. This should work on any
-Linux/OSX system with docker installed:
-
-```sh
-./scripts/wasmd/start.sh
-./scripts/wasmd/init.sh
-WASMD_ENABLED=1 yarn test
-./scripts/wasmd/stop.sh
-```
+See [HACKING.md](HACKING.md).

From 0df64748291c541d5a8cbcdda304d9b5646b6976 Mon Sep 17 00:00:00 2001
From: Simon Warta <simon@warta.it>
Date: Tue, 30 Jun 2020 11:37:09 +0200
Subject: [PATCH 3/3] Implement review feedback

---
 HACKING.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/HACKING.md b/HACKING.md
index c7266eaf..70c235b8 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -20,7 +20,7 @@ systems. Please see [this website](https://git-lfs.github.com/) for instructions
 how to install it.
 
 If you installed git-lfs after cloning this repo, use this command to replace
-the links with the original files: `git lfs checkout`.
+the links with the original files: `git lfs fetch && git lfs checkout`.
 
 To verify everything worked as expected, check if the testing contracts are
 correctly checked out:
@@ -77,6 +77,6 @@ After you modified a file, check if the linter is happy:
 ```sh
 yarn lint
 
-# or if you want liniting plus automatic fixing
+# or if you want linting plus automatic fixing
 yarn lint-fix
 ```