contributing.md

Contributing Docs

Goals

Keep the docs tree accurate, mirrored across languages, and grounded in current repository behavior.

Rules

1. Keep English and Chinese page paths mirrored.
2. Prefer updating both languages in the same change.
3. Document current behavior first. Mark future or planned behavior clearly.
4. Use short sections, direct language, and concrete examples.
5. Fix links when moving files.

Writing Style

• Prefer active voice.
• Omit needless words.
• Use bullets for quick scanning.
• Use code blocks only for commands, config, or code.

When a Translation Lags Behind

If you can only update one language, add a short note at the top of the other page saying it needs sync. Do not silently let the two versions drift.

Suggested Workflow

1. Update the English source page.
2. Mirror the same structure in the Chinese page.
3. Check local links.
4. Update docs/README.md if the tree changes.