search

finwo / gunjs-currency

Initial repo for gunjs-based currency development
Other
0 stars 3 forks source link

Specification formatting #5

Open finwo opened 4 years ago

finwo commented 4 years ago

We need a standard for writing whitepapers and specifications, to prevent styles of multiple people mixing into something that's hard to follow.

My suggestion would be to follow https://finwo.nl/specifications/#SD0003

finwo commented 4 years ago

@W4G1 What are your thoughts on this?

W4G1 commented 4 years ago

Sounds good to me, but I'd recommend keeping things as simple as possible.

Take the JavaScript styling for example: Why not just use a linter like ESLint or StandardJS instead of writing the whole specification on paper yourself, which is also bound to cause more formatting inconsistencies since we then have to check & format the code manually.

finwo commented 4 years ago

The specification I've written in the past is compatible with eslint (providing only a few extra rules), so the manual labour can be kept to a minimum.

finwo commented 4 years ago

What I meant in the initial issue text was to have a standard for writing specifications once we're set on things like a wire protocol, data structure, etc.