Repository navigation
docs: add a writing style guide for contributors - #86
Open
wufangyong973 wants to merge 1 commit into
Open
wufangyong973 wants to merge 1 commit into
wufangyong973 wants to merge 1 commit into
Conversation
|
This pull request has merge conflicts with |
wufangyong973
force-pushed
the
gfi/49-writing-style
branch
from
October 22, 2026 22:28
28a47a0 to
3686c5f
Compare
Malware and injection scan0 blocking, 3 to review, 0 scanner error(s), 27 changed file(s). Needs maintainer review
Scanned commit 3686c5f. Full run and report This pull request will not be merged automatically. A maintainer will review the findings; if they are false positives, they can merge it by hand. Pushing a new commit runs the scan again. |
This branch has not been deployed
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
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.
Fixes #49.
New
contributing/style.md(nav_order 13) pins the house conventions the pages only follow by habit today: plain declarative voice, a fixed terminology table (mandate / vault / keeper / plan / charge, each pointing at the page that defines it), money-as-integers with a one-time human-readable display, language-tagged code blocks that stay runnable against testnet, phone-width table limits, sentence-case headings, and the README==index keep-in-sync rule.Linked from a new Contributing section in
SUMMARY.mdand appended to the introduction of bothREADME.mdandindex.md(kept in sync, as the repo invariant requires). Every cross-link was checked to resolve against the current tree.Closes #49