typst-jp / typst-jp/docs

メンテナー向けのガイドラインを整備する

Open
#49 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Rust
Stars
62
Forks
18
Avg merge
2d 19h
Merged PRs (30d)
6

Description

  • レビューの心得や上流リポジトリの取り込み方法、意思決定の背景などを文章化し、属人化を防ぎたい

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation structure and the project's upstream workflow before deciding where maintainer guidance belongs. Document review practices, upstream repository synchronization, and the background behind decisions, with the goal of reducing knowledge tied to individuals.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.