Skip to content

Programmer's Handbook

A guide to coding for the team from old programmers to new.

Why?

Evolving Code Complexity

As the years go by and Campion College continues to participate in the First Tech Challenge, our codebase will inevitably grow in complexity and abstraction. This is a natural progression as we incorporate new features, optimize existing ones, and implement more sophisticated strategies. As the codebase expands, maintaining clarity and structure becomes crucial to keeping it manageable and accessible.

Guide for New Programmers

This guide is primarily designed to help new programmers integrate into our team smoothly. It not only introduces the principles and standards we follow but also provides a detailed outline of our code structure and the abstractions we use. By understanding these foundational elements, new team members can quickly grasp how our system is organized, making it easier for them to contribute effectively.

Team Coding Standards

This also serves as a rubric and reference for all team members, outlining the practices expected of every programmer, regardless of experience level. It ensures that our code remains clean, well-documented, and consistent, which is essential for collaboration and future development.

Creating a Scalable Codebase

Whether you’re new to the team or an experienced member, this guide will help you understand both the high-level principles that guide our coding practices and the specific structures and abstractions we employ. By following these guidelines, we can build a robust, scalable codebase that will support our team’s success in the First Tech Challenge for years to come.