Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 615 Bytes

File metadata and controls

22 lines (15 loc) · 615 Bytes

Development Guidelines

This document contains critical information about working with this codebase. Follow these guidelines precisely.

Build

  • To build the project: make.
  • To run tests: make test.
  • To install: make install.

Tests

  • When adding a new feature, add tests for the feature as well.
  • When fixing a bug, add regression tests for the bug as well.
  • After making any change and adding any required tests, make sure that the project builds and that all tests pass.

Code quality

  • Line length: 80 chars maximum.
  • Comments must be full sentences, and end with a period.