import{_ as s,o as a,c as n,O as t}from"./chunks/framework.47aa8d5b.js";const m=JSON.parse('{"title":"Standards Guide","description":"","frontmatter":{},"headers":[],"relativePath":"development/docs/standards.md","filePath":"development/docs/standards.md","lastUpdated":1677868200000}'),o={name:"development/docs/standards.md"};function l(i,e,r,p,c,d){return a(),n("div",null,e[0]||(e[0]=[t(`

Standards Guide

Listed here are the standards that are used for the EyeTrackVR project. These standards are used to ensure that the project is consistent and easy to understand.

Code Standards

General

It is by design that we use a static-site framework for the documentation site. This is to ensure that the documentation is easy to maintain and extend. This is also to ensure that the documentation is easy to understand.

We have only a few rules for the documentation site:

Git Commit Style

We use the Conventional Commits standard for our git commit style. This is to ensure that our git commits are easy to understand and easy to maintain. This is also to ensure that our git commits are easy to extend.

Git commits are used to with the Semantic Release tool to automatically generate the changelog and versioning for the project. As such, it is important that we follow the Conventional Commits standard, with our own rule customizations.

The following is a list of the customizations that we have made to the Conventional Commits standard:

Our git commit style is as follows:

bash
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The following is a list of the types that we use:

An example of our git commit style is as follows:

bash
feat: add a new feature # this is the commit title

- added new thing # some detail about the new thing

BREAKING CHANGE: this is a breaking change #this line is optionaland only used if needed
`,18)]))}const u=s(o,[["render",l]]);export{m as __pageData,u as default};