wiki/contributing/formatting/projects.md

21 lines
883 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Project Standards
description:
published: true
date: 2024-05-06T02:03:27.122Z
tags:
editor: markdown
dateCreated: 2024-05-05T21:22:30.441Z
---
# Naming
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.
# Structure
All projects should provide:
- A devenv when applicable, preferably in the form of direnv.
- If devenv is applicable also provide a flake.lock
- A short summary of what the project does, as well as how to use the project in a top level README.md
- The README should include a badge of who the repository is maintained by
- A CONTRIBUTING.md file top level that tells people how to contribute to said project
- A top level LICENSE file or folder of which includes the License or Licenses used in the project