auxolotl/wiki
20
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Activity
wiki/contributing/formatting/projects.md
coded (Samuel Shuert) 9d9a5ed703 docs: update contributing/formatting/projects
2024-05-06 01:31:53 +00:00

883 B
Raw Blame History

title description published date tags editor dateCreated
Project Standards true 2024-05-06T01:31:52.407Z markdown 2024-05-05T21:22:30.441Z

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.

Structure

All projects should provide:

  • 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