Open Payments style guide

Before committing changes

Run the following command in the doc directory:

pnpm format

Why tho? ಠ╭╮ಠ

After a Starlight upgrade to open-payments

cd <to project folder>
pnpm install
cd docs
pnpm start

Nouns

Common nouns

• payment pointer
• wallet address

Proper nouns

• Interledger
• Interledger Protocol (can be abbreviated to ILP after first use on a page)
• Open Payments (always spell out, do not abbreviate as OP)
• Rafiki
• Web Monetization (always spell out, do not abbreviate as WM)

Spellings

Open Payments

Spell as two words, not one (OpenPayments).

Pnpm format

Why do we have to run pnpm format before we commit our changes?

1. Because the Open Payments project demands it.
2. It ensures all outputted code conforms to a consistent style.

For example, if you’re like Melissa and add italics in markdown using single asterisks:

I'm making *this part* italic.

Running pnpm format automatically converts the asterisk set to underscores:

I'm making _this part_ italic.