en Contributing - chiba233/yumeDSL GitHub Wiki

Contributing

Home | Security

The full contributing guide — dev setup, commit conventions, code guidelines, maintenance boundaries, PR requirements — lives in the repo root: CONTRIBUTING.md.

This page only covers wiki-specific notes.


Wiki documentation contribution notes

  • English and Chinese wiki pages must be updated together. Single-side-only changes are not accepted.
  • Code line numbers, function names, and field names referenced in the wiki must match the current source. If the source changed and the wiki did not keep up, fix both.
  • Performance data (empirical constants, benchmark tables) should only be updated when backed by new benchmark runs — do not edit numbers based on guesswork.
  • The version-semantics timeline tables record public-observable behavior or public-surface changes only. Pure internal optimizations do not get their own row unless they affect the constant-factor analysis.