Docs: StyleGuide.md as single source of truth for coding style - #101
Docs: StyleGuide.md as single source of truth for coding style#101omonien wants to merge 1 commit into
Conversation
Introduce a compact DEC style guide consolidating CONTRIBUTING rules, DEC65.pdf section 3.7.1 structure notes, de-facto library conventions, and adapted Delphi Style Guide practices. Point CONTRIBUTING and readme at the guide; enforce for new/rewritten code only, without reformatting existing sources.
af6cff9 to
f10a90b
Compare
|
I'm currently reading the styleguide, as far as I am it's mostly good. Eight things:
if IsReady then Is not too clever. In this example I wouldn't wrap Process(AValue); in begin / end, as this is simply unnecessary.
|
Summary
Docs/StyleGuide.mdas the single source of truth for DEC coding style, structure, and contribution expectations for new / rewritten code.CONTRIBUTING.md,DEC65.pdf§3.7.1 (structure & style), de-facto library conventions (DEC…units, Apache headers, FPC/Delphiuses), and adapted practices from the modern Delphi Style Guide (naming prefixes, formatting, XML docs).CONTRIBUTING.mdinto a short process entry point that points at the style guide.readme.mdso contributors find the style guide next to the other project docs.Policy (explicit)
Docs/StyleGuide.md.DEC65.pdf§3.7.2+) stays in the PDF; when the PDF is next regenerated, §3.7.1 can shrink to a pointer atDocs/StyleGuide.md.Test plan
Docs/StyleGuide.mdfor DEC fit (FPC, unit naming, headers).CONTRIBUTING.mdandreadme.mdlinks resolve..pas/ build changes — nothing to compile.