Skip to content

Commit 292e24a

Browse files
committed
Coding rules and specs update
1 parent 5792896 commit 292e24a

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Coding rules
2+
3+
- No global variables. No thread-local variables. No global logger or anything similar.
4+
- No sleeping a thread. Everything asynchronous.
5+
- Panic as soon as something weird is detected. Don't try to continue running the program if we detect a state inconsistency.
6+
- Code sharing between components kept to a minimum. Code must be isolated as much as possible.
7+
- Things like Prometheus or RPC endpoints must not be rooted deep in the code. It must theoretically be easy to remove support for Prometheus or the RPC server from this library. Prefer pulling information from components from a higher-level rather than passing `Arc` objects around.
8+
- Rustfmt is used.

polkadot_re_spec.pdf

236 KB
Binary file not shown.

0 commit comments

Comments
 (0)