Skip to content

Commit ac9bbb4

Browse files
committed
Add 'protocols and serialization' section
1 parent be4e3dc commit ac9bbb4

2 files changed

Lines changed: 37 additions & 6 deletions

File tree

.hunspell_dict

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,22 @@ systemd
8989
subdirectories
9090
grafana
9191
PlotJuggler
92+
TCP
93+
tcp
94+
ros
95+
guix
96+
vectorization
97+
quaternion
98+
RPY
99+
YPR
100+
quaternions
101+
POSIX
102+
UUID
103+
Toolchain
104+
toolchains
105+
Templated
106+
templated
107+
initializer
108+
src
109+
Bufferization
110+
UDP

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
- [Coordinate systems](#coordinate-systems)
3232
- [Geodetic coordinates](#geodetic-coordinates)
3333
- [Date, time, and locale](#date-time-and-locale)
34+
- [Protocols and serialization](#protocols-and-serialization)
3435
- [General style policies](#general-style-policies)
3536
- [Naming](#naming)
3637
- [Formatting](#formatting)
@@ -133,6 +134,9 @@ Programming languages
133134
wrong -- it is a general purpose automation utility. It was not
134135
superseded by cmake or whatnot in this context.
135136

137+
- There are a few modern alternatives to `make` such as
138+
<https://github.com/go-task/task> or <https://github.com/casey/just>.
139+
136140
- Don't forget that `/bin/sh` is not the same thing as `/bin/bash`.
137141

138142
Version control
@@ -255,7 +259,7 @@ Documentation
255259
<https://github.com/NaturalDocs/NaturalDocs>, <https://github.com/hdoc/hdoc>,
256260
<https://github.com/vovkos/doxyrest>,
257261
<https://github.com/copperspice/doxypress>, but they do not seem to be
258-
significantly better than doxygen atm.
262+
significantly better than doxygen ATM.
259263

260264
- Each repository must contain a README.md file with a brief description of its
261265
purpose.
@@ -546,11 +550,6 @@ Geodetic coordinates
546550
and computationally expensive due to sea level determination logic. Ellipsoid
547551
altitude should be preferred in practice.
548552

549-
- Do not use 32-bit floats for storing geodetic coordinates, this leads to a
550-
substantial, a couple of meters, errors simply due to representation limits.
551-
If memory usage is a concern, use 32-bit integers instead to get much smaller
552-
and uniform errors.
553-
554553
Date, time, and locale
555554
======================
556555

@@ -572,6 +571,19 @@ Date, time, and locale
572571
<https://github.com/zeux/pugixml/issues/469>. To be on a safe side, enforce
573572
`C` (`POSIX`) locale in deployment and while performing formatted I/O.
574573

574+
Protocols and serialization
575+
===========================
576+
577+
- Do not use 32-bit floats for storing geodetic coordinates, this leads to a
578+
substantial, a couple of meters, errors simply due to representation limits.
579+
If memory usage is a concern, use 32-bit integers instead to get much smaller
580+
and uniform errors.
581+
582+
- Do not store UUID as string – weirdly enough it is a common thing, each UUID
583+
is 128 bit long label
584+
(<https://en.wikipedia.org/wiki/Universally_unique_identifier>) and should be
585+
stored like that.
586+
575587
General style policies
576588
======================
577589

0 commit comments

Comments
 (0)