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 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 diff --git a/p2p/README.md b/p2p/README.md index 3d0e9eeb..9a8ddc6c 100644 --- a/p2p/README.md +++ b/p2p/README.md @@ -1,13 +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.
+Docs: -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 +- [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 \ No newline at end of file