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:27:43 +00:00 committed by Auxolotl Wiki
parent 60a6adca25
commit 52986cc9c2
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
contributing/formatting/repo.md
View file

@ -2,17 +2,20 @@
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:20:02.885Z date: 2024-05-06T01:27:42.479Z
tags: tags:
editor: markdown editor: markdown
dateCreated: 2024-05-05T21:22:30.441Z dateCreated: 2024-05-05T21:22:30.441Z
--- ---
# Repository Creation # Repository Standards
## Naming ## Naming
All names, including but not limited to CI Actions and Respository Names, must follow lower-kebab-case 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 a devnev if feasible, preferably in the form of direnv. All projects should provide:
- All projects should provide a short summary as well as how to use the project in a top level README\.md - 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
- The README should include a badge of who the repository is maintained by
- A CONTRIBUTING.​md file top level that tells people how to contribue to said project