Contribution guide

AI usage

Tab completion

Cursor Tab & Copilot NES

Code analysis

Translation from English

Feel free to use them as long as you don't take their outputs at face value.

Translation into English

Ditto, but be careful of whether optional parts in the original non-English language are correctly complemented in English (where they are mandatory), and whether expressions that don't make sense when literally translated to English are correctly converted to natural English expressions while preserving the original intent. When encountering unfamiliar expressions in the translation, either consult a dictionary or have an AI explain them to you. For reference, there is a technique where you first machine-retranslate the English text into your native language for rough verification.

Code generation by Agents

For non-trivial changes:

• Disclose the names of the tools and the main model you used (unless the committer or co-author is the tool or the model itself), (the summary of) the initial prompt you told to the agent, and context information (e.g. relevant URLs or repositories) in that prompt in the PR description.
• If you used the plan mode (or a similar plan-driven approach), disclose the plan the Agent told you, and additional information (context) in your prompt other than "Start Implementation" (if any) when you asked the Agent to implement the plan.
• You are responsible for each line of code generated by the Agent.
• You shall finish the review of the generated code by yourself before the maintainer(s) start(s) the review of the PR, and make sure the generated code is correct, secure, and maintainable.

For trivial changes where you can expect (nearly) identical results whether done by yourself or an AI agent, feel free to delegate tasks to it.

The maintainer(s) reserve(s) the right to ask for more information about the AI usage, or to reject your PR if the disclosure is insufficient or if they suspect that you (blatantly) violated these rules (depending on e.g. the frequency of the PRs and the amount and quality of code in the PR). If you are violating the rules too badly, the maintainer(s) reserve(s) the right to block you.

Submit an issue or PR / Issue・PRの投稿 / 提出一个issue或PR / 이슈 및 PR 제출

Please submit an issue or PR in English or Japanese. English is recommended.

Issue・PRは英語か日本語で投稿してください。英語を推奨します。

请用英语或日语提交问题或PR。建议使用英语。

이슈나 PR은 영어 또는 일본어로 제출해 주시기 바랍니다. 영어를 권장합니다.

Issue reporting

For output issues, please provide the input, the expected output, the actual output, and the offending Markdown parsers (if you know) in the issue description. Also, please provide the reproduction URL of the playground if you can.

出力の問題については、入力・期待される出力・実際の出力・問題のあるMarkdownパーサー（わかる場合）をIssueの説明に記載してください。また、可能であればPlaygroundの再現URLも添えてください。

对于输出问题，请在Issue描述中提供输入、预期输出、实际输出以及有问题的Markdown解析器（如果知道的话）。如果可能，请提供Playground的重现URL。

출력 문제의 경우, 입력, 예상 출력, 실제 출력 및 문제가 있는 Markdown 파서(알고 있다면)를 이슈 설명에 제공하십시오. 또한 가능하다면 플레이그라운드의 재현 URL도 제공하십시오.

Build

This repository adopts pnpm as a package manager.

To build all packages, run:

pnpm i
node --run build

To run tests, run:

node --run test

Add a changeset to a PR that affects publishable packages

This repository uses Changesets for all publishable packages under packages/ except markdown-it-cj-friendly. If your PR affects any of those packages, please add a changeset to the PR as follows:

1. Add a changeset with node --run changeset.
2. Choose major, minor, or patch according to https://semver.org/.
3. Edit the created changeset and commit it together.

Of course, if you are sure that your PR does not affect any packages, you do not need to add a changeset. (Please add a note in the PR summary.)