Skip to main content

Introduction

Welcome to our internal engineering documentation! This repository contains all the information, guidelines, and best practices for our software development team.

Purpose of This Documentation​

As our agency continues to grow, this documentation serves several critical purposes:

  1. Knowledge Sharing: Centralize our collective knowledge about processes, standards, and technologies
  2. Onboarding: Help new engineers quickly get up to speed with our practices
  3. Consistency: Ensure consistent development practices across all projects
  4. Quality Assurance: Maintain high standards in our deliverables
  5. Efficiency: Reduce time spent answering repetitive questions

How to Use This Documentation​

This documentation is organized into several key sections:

  • Getting Started: Company overview, team structure, and initial setup
  • Coding Standards: Style guides, naming conventions, and quality requirements
  • Development Workflows: Git practices, PR processes, and code reviews
  • Project Management: How we manage projects and interact with clients
  • Technical Stack: Information about our technology stack and frameworks
  • Common Practices: Security, performance, accessibility, and QA guidelines

Contributing to This Documentation​

We encourage all team members to contribute to this documentation. If you find something that's missing, outdated, or could be improved, please make updates or additions. Here's how:

  1. Fork the repository
  2. Make your changes
  3. Submit a pull request with a clear description of your updates
  4. Your changes will be reviewed and merged

Getting Help​

If you have questions that aren't answered in this documentation, please reach out to:

  • Your direct team lead
  • The engineering manager
  • The Kirana Labs Tech Teams group

Remember, this is a living document that will evolve as our team and processes grow.