Skip to content

Developer Documentation

Welcome to the CodeMetrics developer documentation! Whether you're new to the project or an existing contributor looking for a refresher, this is your guide to understanding how we work.

Getting Started

If you're new to the project (or otherwise interested in how we do things), this documentation covers our development approach, coding standards, architectural patterns, and practices that help us maintain a high-quality codebase.

Key Resources

Here are the key resources for contributors:

  • Standards and Patterns - Our coding standards, architectural patterns, and development norms for both frontend and backend
  • Testing Guide - Running unit tests, integration tests, and LocalStack AWS testing
  • Datastores for Development - Local datastore workflows, DynamoDB with LocalStack, and debugging datastore state during development
  • Lambda for Development - LocalStack-based Lambda packaging, deployment, and invocation workflows for contributors
  • Secrets for Development - LocalStack-based Secrets Manager setup and test secret workflows for contributors
  • Architecture - The system architecture and integration points
  • Mocks - Information about the mock services for testing and development
  • Release Process - How we handle versioning, releases, and changelogs

Contributing

We welcome contributions from everyone! Before you start, please familiarise yourself with our standards and patterns to ensure your contributions align with our project's approach.

When making changes:

  1. Follow our coding standards and architectural patterns
  2. Write tests for your changes
  3. Use Conventional Commits for your commit messages
  4. Create focused pull requests that address a single concern

Getting Help

If you have questions or need clarification about anything in this documentation, please reach out to the core team through GitHub issues or discussions.

Thank you for contributing to CodeMetrics!