CONNECTING TO KAMITSUBAKI_CITY...

Back to home Read the full contribution guide

CONTRIBUTOR ONBOARDING

Full Guide Before Editing

This page is aligned with the current workflow of the repository.

You can switch freely between two versions below:

  • Complete beginner: a slower step-by-step walkthrough
  • With coding experience: a faster repo-model and PR-flow version

Both paths lead to the same GitHub editor for the current source file.

About to edit

First confirm that the path shown below is really the source file you intend to change.

If it is wrong, stop here. Go back to the relevant wiki article and enter again from the local “Edit source file” link so you do not start with the wrong file.

No valid edit target was found. Enter from the “Edit source file” button on a specific wiki article.

Choose your guide version

Complete beginner

Best for people making a first contribution to this repository, or anyone not yet comfortable with Markdown, GitHub web editing, PRs, or CI. It explains more of the path in plain language.

01

Step 01

Step 1: confirm exactly which file you are about to change

The path shown at the top of this page is the real repository file you are about to edit.

Read that path first and classify it:

  • src/content/artists/...: artist, creator, group, and similar entry pages
  • src/content/projects/...: project and derived-plan pages
  • src/content/logs/...: observation logs, news, and timeline updates
  • src/content/site/...: homepage labels, navigation, footer copy, section text
  • src/content/contribute/...: the contributor guide pages themselves

If you are fixing copy, adding facts, updating metadata, or adjusting images, that is usually a content edit and should stay inside src/content/.

02

Step 02

Step 2: remember that content and implementation are separate here

The most important rule for beginners is:

Most wiki contributions change content files, not page code.

So start by asking “which content file should this live in?” rather than “which component should I change?”

The most common shapes are:

src/content/artists/<category>/<entry>/<locale>.md
src/content/projects/<category>/<project>/<locale>.md
src/content/logs/<year>/<record>/<locale>.md

The homepage sections 01. DATABASE, 02. PROTOCOLS, and 03. LOG are designed to render from this structure automatically.

03

Step 03

Step 3: learn the metadata block at the top of a file

Each entry file has two parts: frontmatter and body content.

The frontmatter is the block between the opening --- lines. It stores structured metadata. The body comes after the second --- and contains the actual wiki writing.

---
locale: "en"
translationKey: "kaf"
name: "KAF"
romanizedName: "KAF"
statusLabel: "STATUS"
status: "ACTIVE"
image: "https://example.com/image.jpg"
---

The first fields to understand are:

  • locale
  • translationKey
  • name
  • romanizedName
  • statusLabel and status
  • image

translationKey must remain identical across the localized files, or the site will stop treating them as one entry.

Artist entries can also include theme, which controls the article theme color and the palette panel in the infobox.

theme:
  name: "KAF Bloom"
  accentColor: "#F29AC2"
  mutedColor: "#E63145"
  surfaceColor: "#111321"
  highlightColor: "#FFF6FA"
  palette:
    - label: "KAF Pink"
      value: "#F29AC2"
    - label: "Bloom Red"
      value: "#E63145"

Do not invent colors casually. Prefer official artist pages, official key visuals, official album covers, or character material. Put the strongest recognition color in accentColor, and keep surfaceColor dark enough for comfortable reading.

04

Step 04

Step 4: follow the three-language rule when creating entries

The site supports three locale routes:

/zh/  Chinese, default locale
/ja/  Japanese
/en/  English

So when you add a new translatable record, the safest pattern is:

  • create zh.md
  • create ja.md
  • create en.md

Even if the body text is incomplete, try to create the full structure from the start.

05

Step 05

Step 5: write the body as clean Markdown

The article body is ordinary Markdown. You can use:

  • paragraphs
  • lists
  • bold text
  • blockquotes
  • inline code and code blocks
  • tables
  • links

When in doubt, start from the most stable information:

  1. basic identity details
  2. debut timing or project affiliation
  3. official links or source notes
  4. then fuller descriptive paragraphs

Avoid these mistakes:

  • editing dist/, .astro/, or node_modules/
  • moving large wiki passages into implementation files
  • filling empty sections with placeholder copy
06

Step 06

Step 6: what to do when GitHub opens

After you use the final action on this page, GitHub will usually open the web editor for the current file.

Once you are there:

  1. confirm the file path still matches the one shown here
  2. edit the frontmatter or article body
  3. scroll to the commit form
  4. write a short, clear commit message

If GitHub asks how to save the change:

  • already on your own branch: commit directly there
  • not on your own branch: choose Create a new branch for this commit and start a pull request
07

Step 07

Step 7: after saving, the workflow becomes PR plus CI

This repository uses a GitHub Pull Request workflow.

A normal path looks like this:

  1. edit the file
  2. commit to your branch
  3. open a Pull Request
  4. wait for CI
  5. address review comments or failing checks

The core validation commands are:

pnpm test
pnpm check
pnpm build

If CI fails, keep working on the same branch. You do not need a new PR.

08

Step 08

Step 8: the most common mistakes

The usual mistakes are:

  • editing the wrong file path
  • forgetting one of the locale files
  • letting translationKey drift across locales
  • mixing content edits with implementation changes
  • committing generated output
  • using placeholder text instead of real content

Quick self-check:

  1. Am I editing something inside src/content/...?
  2. Have I considered the localized files?
  3. Am I changing content, not implementation?
  4. Would another maintainer immediately understand what changed?

Start editing the current source file

If the guide above makes sense, you are ready to continue.

The two links below serve different purposes:

  • Still want to review repository rules: open the full contribution guide
  • Already know you want to change this exact file: open the GitHub editor for the current source file

After that, continue with the normal path:

  1. edit the file
  2. commit to your branch
  3. open a Pull Request
  4. wait for CI
  5. keep fixing review or CI issues on the same branch