Docs: StyleGuide.md as single source of truth for coding style#101
Open
omonien wants to merge 1 commit into
Open
Docs: StyleGuide.md as single source of truth for coding style#101omonien wants to merge 1 commit into
omonien 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.