- Home
- Engineering
- Coding Standards
Coding Standards
Guidelines for code quality, formatting, and reviews at Zoos Global.
We enforce these standards to ensure our codebase remains clean, readable, and maintainable.
Language Guidelines
Section titled “Language Guidelines”TypeScript / JavaScript
Section titled “TypeScript / JavaScript”- Use TypeScript for all new projects.
- Set
strict: truein yourtsconfig.json. - Avoid the use of
any; preferunknownor define explicit interfaces/types. - Use async/await syntax over raw Promise chain callbacks.
- Format code strictly with
gofmtandgoimports. - Handle all errors explicitly. Do not ignore errors with
_. - Keep functions short and highly focused.
Formatting & Linting
Section titled “Formatting & Linting”All projects must use Prettier for formatting and ESLint (or language-equivalent linter) for static analysis. Linter checks are run automatically on commit hook (via Husky) and in our CI/CD pipelines.
Code Reviews
Section titled “Code Reviews”All changes must go through a code review via a GitHub Pull Request.
Reviewer Checklist:
Section titled “Reviewer Checklist:”- Does the code adhere to the architectural standards?
- Are there unit tests covering edge cases?
- Are secrets or API keys accidentally exposed in the code?
- Is there documentation updated for public APIs or breaking changes?

