auxolotl/wiki
20
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Activity

docs: update contributing/formatting/repo

Browse source
This commit is contained in:
coded (Samuel Shuert) 2024-05-06 01:28:20 +00:00 committed by Auxolotl Wiki
parent 8a4b91e4cf
commit 26644b26cf
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
contributing/formatting/repo.md
View file

@ -2,18 +2,16 @@
title: Repository Standards title: Repository Standards
description: Formatting rules for new repositories description: Formatting rules for new repositories
published: true published: true
date: 2024-05-06T01:27:55.416Z date: 2024-05-06T01:28:19.608Z
tags: tags:
editor: markdown editor: markdown
dateCreated: 2024-05-05T21:22:30.441Z dateCreated: 2024-05-05T21:22:30.441Z
--- ---
# Repository Standards # Naming
## 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. 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 # Structure
All projects should provide: All projects should provide:
- A devnev when applicable, preferably in the form of direnv. - 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.​md - A short summary of what the project does, as well as how to use the project in a top level README.​md