From 52986cc9c2deb7f835e43295b45556089fb29170 Mon Sep 17 00:00:00 2001 From: "coded (Samuel Shuert)" Date: Mon, 6 May 2024 01:27:43 +0000 Subject: [PATCH] docs: update contributing/formatting/repo --- contributing/formatting/repo.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/contributing/formatting/repo.md b/contributing/formatting/repo.md index 84fb59c..a1055db 100644 --- a/contributing/formatting/repo.md +++ b/contributing/formatting/repo.md @@ -2,17 +2,20 @@ title: Repository Standards description: Formatting rules for new repositories published: true -date: 2024-05-06T01:20:02.885Z +date: 2024-05-06T01:27:42.479Z tags: editor: markdown dateCreated: 2024-05-05T21:22:30.441Z --- -# Repository Creation +# Repository Standards ## 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 -- All projects should provide a devnev if feasible, preferably in the form of direnv. -- All projects should provide a short summary as well as how to use the project in a top level README\.md +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.​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