2024-05-05 21:22:32 +00:00
---
2024-05-06 01:28:57 +00:00
title: Project Standards
description:
2024-05-05 21:22:32 +00:00
published: true
2024-05-06 01:28:57 +00:00
date: 2024-05-06T01:28:55.630Z
2024-05-05 21:22:32 +00:00
tags:
editor: markdown
dateCreated: 2024-05-05T21:22:30.441Z
---
2024-05-06 01:28:20 +00:00
# Naming
2024-05-06 01:27:43 +00:00
All names, including but not limited to CI Actions, Respositories, and folder names inside the project, must follow lower-kebab-case except in cases where a program requires something else.
2024-05-06 01:20:04 +00:00
2024-05-06 01:28:20 +00:00
# Structure
2024-05-06 01:27:43 +00:00
All projects should provide:
- A devnev when applicable, preferably in the form of direnv.
- A short summary of what the project does, as well as how to use the project in a top level README.
- The README should include a badge of who the repository is maintained by
2024-05-06 01:27:56 +00:00
- A CONTRIBUTING.
