Contributing

April 11, 2026 · View on GitHub

Thank you for helping improve DocuMate.

Issues

Use GitHub Issues for bugs and feature requests.
Include editor and version (VS Code or Cursor + version), DocuMate extension version, language mode (PHP / JavaScript), and steps to reproduce when reporting bugs.

Pull requests

Fork the repository and create a branch from main (or the branch the maintainer specifies).
Run npm run lint and npm test before opening a PR; fix any new warnings.
Keep changes focused: one concern per PR when possible.
Update CHANGELOG.md for user-visible behavior changes (maintainer may adjust wording).

Code style

JavaScript with CommonJS (require / module.exports) to match the current codebase.
Follow existing patterns in language/ for new snippet logic.
ESLint is the source of truth for style and obvious footguns (eslint.config.mjs).

Documentation

When behavior or contribution points change, update:

Root README.md if end users are affected.
doc/reference.md for new commands or documate.* keys.
doc/architecture.md if structure or data flow changes materially.