Release of laminar 0.1.0


(Fletcher) #1

Release Notes

The Networking team is happy to announce the release of 0.1.0 of the laminar crate. It provides UDP networking modified for the needs of game networking. Most of the techniques used were published and detailed by Glenn Fiedler at https://gafferongames.com/. We’d like to extend a special thanks to him and his articles.

Features

  1. UDP-based protocol
  2. Fragmentation
  3. Retry logic for packets
  4. Detection and notification of client disconnects via mpsc channels
  5. A link conditioner to simulate packet loss and latency
  6. Well tested by integration tests and unit tests
  7. Benchmarks

Workflow

As a team, we adopted the following the workflow agreements. When we begin work on the amethyst_network crate, we’ll use the same agreements. They are focused on maintaining a high level of quality in the code, and for working with a highly distributed team. We’re including them here as some of the other teams may find them of use.

  1. All warnings produced by cargo test are treated as errors by the CI/CD system
  2. All Clippy warnings are treated as errors by the CI/CD system
  3. We use kcov to track our code coverage; we do not have a required minimum, rather we use this as a potential indicator of issues
  4. We included sample code about using the library
  5. Setting up a benchmarking framework so we can track regressions
  6. Unit and integration tests, as well as release testing with docker-compose

Style Guidelines

As a team, we (eventually) agreed on a coherent style for all our work. See this document for more information.

Summary

Some of the most helpful ones have been:

  1. Keep PRs small, preferably under 200 lines of code when possible
  2. Comments should explain why, not what
  3. You must provide comments for public API
  4. No hard-coded values
  5. No panics nor unwraps in non-test code
  6. rustfmt should be done as its own PR, to avoid generating giant PRs that are impossible to review
  7. We make use of the forking workflow