From a29c67563c2b63cd1dabd746a80264742d716669 Mon Sep 17 00:00:00 2001 From: Zach Date: Sun, 14 Jan 2018 13:43:26 +0000 Subject: [PATCH 1/3] Update p2p README, closes #1102 --- p2p/README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/p2p/README.md b/p2p/README.md index a30b83b7..f386c511 100644 --- a/p2p/README.md +++ b/p2p/README.md @@ -1,14 +1,11 @@ -# `tendermint/tendermint/p2p` +# p2p -[![CircleCI](https://circleci.com/gh/tendermint/tendermint/p2p.svg?style=svg)](https://circleci.com/gh/tendermint/tendermint/p2p) +The p2p package provides an abstraction around peer-to-peer communication. -`tendermint/tendermint/p2p` provides an abstraction around peer-to-peer communication.
- -See: - -- [docs/connection] for details on how connections and multiplexing work -- [docs/peer] for details on peer ID, handshakes, and peer exchange -- [docs/node] for details about different types of nodes and how they should work -- [docs/pex] for details on peer discovery and exchange -- [docs/config] for details on some config options +Docs: +- [Connection](../docs/specification/new-spec/p2p/connection.md) for details on how connections and multiplexing work +- [Peer](../docs/specification/new-spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange +- [Node](../docs/specification/new-spec/p2p/node.md) for details about different types of nodes and how they should work +- [Pex](../docs/specification/new-spec/p2p/pex.md) for details on peer discovery and exchange +- [Config](../docs/specification/new-spec/p2p/config.md) for details on some config option From 26aaa283a9266fcbdf18294cb5b450d1b2cf348a Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Sun, 14 Jan 2018 13:49:27 +0000 Subject: [PATCH 2/3] p2p: remove deprecated Dockerfile --- p2p/Dockerfile | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 p2p/Dockerfile diff --git a/p2p/Dockerfile b/p2p/Dockerfile deleted file mode 100644 index 6c71b2f8..00000000 --- a/p2p/Dockerfile +++ /dev/null @@ -1,13 +0,0 @@ -FROM golang:latest - -RUN curl https://glide.sh/get | sh - -RUN mkdir -p /go/src/github.com/tendermint/tendermint/p2p -WORKDIR /go/src/github.com/tendermint/tendermint/p2p - -COPY glide.yaml /go/src/github.com/tendermint/tendermint/p2p/ -COPY glide.lock /go/src/github.com/tendermint/tendermint/p2p/ - -RUN glide install - -COPY . /go/src/github.com/tendermint/tendermint/p2p From 0a20e8f2682ce4854afaaa698c6bef592a187567 Mon Sep 17 00:00:00 2001 From: Adrian Brink Date: Thu, 18 Jan 2018 19:39:07 +0100 Subject: [PATCH 3/3] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..902469b4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ + + +* [ ] Updated all relevant documentation in docs +* [ ] Updated all code comments where relevant +* [ ] Wrote tests +* [ ] Updated CHANGELOG.md