Skip to content

Commit

Permalink
Bump onet to fix TLS websockets
Browse files Browse the repository at this point in the history
Also: Minor fixes to documentation.
  • Loading branch information
Jeff R. Allen committed Oct 9, 2019
1 parent 6f4ad20 commit 506f16c
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 66 deletions.
57 changes: 4 additions & 53 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Scripts for coding and best practices for the DeDiS-workgroup.

## GitHub usage

On top of github, we rely on the [ZenHub](http://ZenHub.io) for project
We use a [GitHub project](https://github.com/orgs/dedis/projects/1) for project
management. We use its board to put each task into a 'pipeline':

- Ready4Merge: pull-requests we think are ready to be merged. Please
Expand All @@ -15,8 +15,6 @@ should be done.
OK to move things around between WIP and the following pipeline
- TODO: Open issues that should be treated next.
- BUG: Issues that make the project behave in a not-wanted way.
- NeedDetails: Issues that are not detailed enough to work on them
and need more explanation.

### Branches

Expand All @@ -25,17 +23,6 @@ All work has to be done in branches. Per default, branches go off from

The branch-name should be one to three words, concatenated using underscores,
followed by the number of the issue it solves.
If you work on a foreign branch, include the start of the foreign branch in
your branch.

Let's say user 1 made a branch `add_platform_lxc_345` and you want to
participate, you'll create a branch that goes off it with the name
`add_platform_lxc_macosxfix_345` and do a pull request to the first branch,
`add_platform_lxc_345`.

There are two scripts, [`gic`](#gid) and [`gid`](#gid), in the `bin`
directory which make it a lot easier to handle a lot of long branch names
and can save you a lot of typing.

### Pull Requests and Issues

Expand All @@ -44,19 +31,16 @@ requests. Ideally this allows to have general discussions in the
issues and more implementation-specific discussions in the pull request.
If a pull request is deleted, the general discussion is still available.

Using Zenhub, you can connect pull-requests and issues, so they show
up as being together in the zenhub-board.

### Assignees

An issue/pull-request with an assignee belongs to this person - he is
responsible for it. Specially for a pull-request, this means:
responsible for it. Specially for a pull-request, this means:

- only the assignee may add commits to this pull-request
- only somebody else than the assignee may merge the pull-request

If somebody else wants to participate on a given pull-request, he can make a
new branch off from this pull-request and continue the work therein:
new branch off from this pull-request and continue the work therein:

```
PR1 with assignee1
Expand All @@ -73,15 +57,11 @@ The general rule is that for each commit, all tests should pass. This is not

### Merge to master

Before merging into master, all tests MUST pass. This can be enforced by
using the ```.git/hooks/pre-push``` hook provided in this repository.
Before merging into master, all tests MUST pass.
Then you have to pass code-review by one or two other developers, which will
comment your code and ask for changes. Only once at least one other
developer is happy with your branch can he merge it.

It is good practice to do a `squash` when merging and adding all important
information about the merge in the squash-comment.

### Travis

A travis-script checks the go-formatting and all tests. Before a merge is done,
Expand All @@ -94,13 +74,6 @@ We aim for ~100% and have 80% as lower boundary. Code containing only `func main
and not much more is OK if it is tested by integration tests and manually instead
of unit tests (for these few packages may have lower code coverage).

### Go-imports and git pre-push

If you have troubles using goimports in your editor, please use the pre-push hook
in this directory for git. If you alread installed the 'bin'-directory with
`add_path_to_mac`, you can just call `add_hooks`. Now everytime before your
changes get pushed, `goimport` renices all your files.

## Comments

Two important links regarding comments:
Expand All @@ -123,28 +96,6 @@ except function- and variable-names that aren't English words.

The standard line-width is 80 characters and this is a hard limit.

## Scripts

Two scripts are provided for more easy switching and cleaning up between
branches.

### gic

The bash script [`gic`](bin/gic) stands for git-checkout. If you call it
without any arguments, it will output a list of all branches that are checked
out, together with a number in front. This lets you easily change between
branches.

New branches that have never been checked out will come in the second part of
the list and can be checked out the same way.

### gid

The script [`gid`](bin/gic) will delete a local branch to make place for new
branches. Called without arguments, it will show a list of all branches
available for deletion, called with a number, it will try to delete that
branch. This can fail if the branch hasn't been pushed.

## Debug-levels

We're using the `cothority/lib/dbg`-library for debug-output which offers a
Expand Down
3 changes: 2 additions & 1 deletion doc/Services.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ on it
an election on a decentralized system using skipchains to store the votes
- [byzcoinx](../byzcoinx/README.md) request and verify
collective signatures in a fault-tolerant manner
- [pop](../pop/service/README.md) create and participate
- [personhood](../personhood/service/README.md) create and participate
in Proof-of-Personhood parties where each participant gets a cryptographic token
that identifies him anonymously as a unique person
- [skipchain](../skipchain/README.md) a permissioned
blockchain for storing arbitrary data if a consensus of a group of nodes is found
- [status](../status/service/README.md) returns the status of a conode
- [calypso](../calypso/README.md) Auditable Sharing of Private Data over Blockchains
41 changes: 30 additions & 11 deletions external/js/cothority/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ require (
github.com/syndtr/goleveldb v1.0.0 // indirect
github.com/urfave/cli v1.22.0
go.dedis.ch/kyber/v3 v3.0.6
go.dedis.ch/onet/v3 v3.0.25
go.dedis.ch/onet/v3 v3.0.26
go.dedis.ch/protobuf v1.0.9
go.etcd.io/bbolt v1.3.3
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,8 @@ go.dedis.ch/kyber/v3 v3.0.6 h1:1X5c/exA3VgFSyVOocMTwzZIlQo4d4jzRurYzoPOv7A=
go.dedis.ch/kyber/v3 v3.0.6/go.mod h1:V1z0JihG9+dUEUCKLI9j9tjnlIflBw3wx8UOg0g3Pnk=
go.dedis.ch/onet/v3 v3.0.25 h1:cFnb1eM441kz3v9i4GQqjfdH7Tbi6ZVlFgfFvhhLR0w=
go.dedis.ch/onet/v3 v3.0.25/go.mod h1:gwdcgrfh6OEzXFvMrgtAVEgdPrmcbZXDQZaDbqB0rjU=
go.dedis.ch/onet/v3 v3.0.26 h1:wQhVGB+SCdG7B0tbo6ZeZINQKWkU4u9TNMkGBH16EEM=
go.dedis.ch/onet/v3 v3.0.26/go.mod h1:gwdcgrfh6OEzXFvMrgtAVEgdPrmcbZXDQZaDbqB0rjU=
go.dedis.ch/protobuf v1.0.5/go.mod h1:eIV4wicvi6JK0q/QnfIEGeSFNG0ZeB24kzut5+HaRLo=
go.dedis.ch/protobuf v1.0.7 h1:wRUEiq3u0/vBhLjcw9CmAVrol+BnDyq2M0XLukdphyI=
go.dedis.ch/protobuf v1.0.7/go.mod h1:pv5ysfkDX/EawiPqcW3ikOxsL5t+BqnV6xHSmE79KI4=
Expand Down

0 comments on commit 506f16c

Please sign in to comment.