Moko Consulting

Open-source software for Joomla, Gitea, and web platforms. Home of MokoSuite, MokoGitea, and MokoCLI.

Tennessee
https://mokoconsulting.tech
Repositories
57
 Projects Packages Code Wiki Members
1
Repositories
57
 Projects Packages Code Wiki Members
1
standards/Documentation

Documentation Standards

README.md

Every repository must have a README with:

  1. Title and description — what the repo does
  2. Installation/setup — how to get started
  3. Usage — basic examples
  4. License — GPL-3.0-or-later (standard)

CHANGELOG.md

Every repository must maintain a changelog:

  • Format: ## [version] - YYYY-MM-DD
  • Group changes under: Added, Changed, Fixed, Removed
  • Update changelog BEFORE creating a PR (required by PR workflow)
  • Keep ## [Unreleased] section at top for in-progress changes

Wiki Pages

  • Use the Wiki Editing standards for all wiki content
  • Every wiki page must include a Revision History table at the bottom
  • Use folder structure for organization (e.g., standards/, cli/, api/)

Code Comments

  • Only add comments where the logic isn't self-evident
  • Don't add docstrings to code you didn't change
  • Use // TODO: for planned work with issue references

Revision History

Date Author Changes
2026-06-21 jmiller Initial consolidation from .profile wiki
Pages