diff --git a/contributing/formatting/projects.md b/contributing/formatting/projects.md index 68abce0..a790ba5 100644 --- a/contributing/formatting/projects.md +++ b/contributing/formatting/projects.md @@ -2,7 +2,7 @@ title: Project Standards description: published: true -date: 2024-05-06T01:28:55.630Z +date: 2024-05-06T01:31:52.407Z tags: editor: markdown dateCreated: 2024-05-05T21:22:30.441Z @@ -13,7 +13,9 @@ All names, including but not limited to CI Actions, Respositories, and folder na # Structure 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 - 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 \ No newline at end of file