Skip to content

docs: add a writing style guide for contributors - #86

Open
wufangyong973 wants to merge 1 commit into
MMM-pay:mainfrom
wufangyong973:gfi/49-writing-style
Open

wufangyong973 wants to merge 1 commit into
MMM-pay:mainfrom
wufangyong973:gfi/49-writing-style

Conversation

@wufangyong973

Copy link
Copy Markdown
Contributor

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.md and appended to the introduction of both README.md and index.md (kept in sync, as the repo invariant requires). Every cross-link was checked to resolve against the current tree.

Closes #49

@github-actions

Copy link
Copy Markdown

This pull request has merge conflicts with main. Please merge main into your branch (or rebase) and push. It will be merged automatically once CI passes.

@github-actions

Copy link
Copy Markdown

Malware and injection scan

0 blocking, 3 to review, 0 scanner error(s), 27 changed file(s).

Needs maintainer review

Rule Location Finding Excerpt
unknown-binary public/fonts/fa-brands-400.eot:1 Adds a binary file of an unexpected type.
unknown-binary public/fonts/fa-regular-400.eot:1 Adds a binary file of an unexpected type.
unknown-binary public/fonts/fa-solid-900.eot:1 Adds a binary file of an unexpected type.

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.

@github-actions github-actions Bot added the security-review Flagged by the malware scan; needs a maintainer label Oct 22, 2026
@titilope12 titilope12 added the do-not-merge Blocked by a maintainer; the auto-merge bot skips it label Oct 23, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge Blocked by a maintainer; the auto-merge bot skips it security-review Flagged by the malware scan; needs a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: writing style guide for contributors

2 participants