Skip to content

Contribute

persian-cli is an open research lab. Most of the useful contributions right now aren’t code, and you don’t need to be an expert in Unicode to make one.

Report a breakage

Have a terminal and 15 minutes? Print our reference line and tell us what breaks. Breakage report →

Add test strings

Write Persian, Arabic, Urdu, Hebrew or another RTL script? Your hard cases make every fix general. Test corpus #17 →

Answer a research question

Pick a question and answer it from primary sources: specs, code at a commit, upstream issues. Research issues →

Translate

The site is English and Persian. Arabic is next, and other RTL scripts are welcome. Arabic locale #19 →

Shape the direction

Weigh in on the research program and its open questions. RFC 0001 →

  1. Logical order is sacred. Never fix display by reversing strings or substituting presentation forms.
  2. Cite primary sources, and link the exact commit you read.
  3. Keep verified and claimed apart. “The README says” is not “the code does”.
  4. Measure. Every claim about behaviour comes with a reproducible case.
  5. Script-general. If it only works for Persian, say why, or generalise it.

Code is licensed under Apache-2.0; docs, research notes, translations and the test corpus under CC BY 4.0. Everyone follows the Code of Conduct.

Read CONTRIBUTING.md

A project by Mehdi Baneshi · mbaneshi.ir