Propose a change

Every page of this guide is a markdown file. Changing one means editing that file and opening a pull request.

Until the repository is public, access is on request. Ask through the enquiry form and say what you want to work on.

What to work on

Good candidates, roughly in order of value:

1. Anything factually wrong on a page. These are the most valuable reports, because nobody is looking for them.
2. A dashed image placeholder you could draw. See Illustration guidelines.
3. An open question on a pattern page that you have evidence for.
4. A case study. See Case studies.

In the browser, for a small change

For a typo or a broken link, once you have access, you never have to leave GitHub.

1. Open the page's file under content/guide/.
2. Click the pencil icon.
3. Make the change.
4. Describe it in a sentence and choose Create a new branch for this commit.
5. Open the pull request.

That is the whole process. No tooling, no checkout.

On your machine, for a real change

A larger change needs a local copy, because you want to read it on the page before anybody else does.

Once

You need Git and Node 22 or newer. A GitHub client such as GitHub Desktop is fine if you would rather not use the terminal.

git clone https://github.com/vincemedia/connectwallet.git
cd connectwallet
npm install
npm run dev

The guide is then at http://localhost:3000, and saving a markdown file updates the page.

Each change

git switch -c fix-send-fees-wording

Edit the file under content/guide/, then check your work:

npm run check

That runs the type check, the linter, the content checks and the contrast checks. The content check is the one most likely to catch you. It flags dead internal links, images not in the manifest, unresolved image prompts, em dashes, banned vocabulary, empty code spans and pages that cannot be reached from the tree. It takes seconds, and it is the same check that runs on your pull request.

git add .
git commit -m "Correct the fee wording on Send fees"
git push -u origin fix-send-fees-wording

Open the pull request

In the description, say three things:

• What changed, in a sentence.
• What you worked from. A proposal number, a documentation page, a conversation with somebody who ships a wallet.
• What you were unsure about. This is the most useful line in the description, and the easiest to leave out.

What happens next

Someone reviews it. Expect questions, and expect at least one to ask whether a claim is true on BSV, and what you checked it against. That is the review doing its job, not a judgement on your work.

See Review for what reviewers look for.

Related

• Content guidelines
• Formatting
• Review