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

docs: update contributing/formatting/projects

Browse source
This commit is contained in:
coded (Samuel Shuert) 2024-05-06 01:31:53 +00:00 committed by Auxolotl Wiki
parent 67fbc51d6d
commit 9d9a5ed703
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
contributing/formatting/projects.md
View file

@ -2,7 +2,7 @@
title: Project Standards title: Project Standards
description: description:
published: true published: true
date: 2024-05-06T01:28:55.630Z date: 2024-05-06T01:31:52.407Z
tags: tags:
editor: markdown editor: markdown
dateCreated: 2024-05-05T21:22:30.441Z dateCreated: 2024-05-05T21:22:30.441Z
@ -14,6 +14,8 @@ All names, including but not limited to CI Actions, Respositories, and folder na
# 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.
- 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 - 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 - 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 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