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

1.1 KiB
Raw Blame History

title description published date tags editor dateCreated
Project Standards true 2024-05-06T20:03:03.088Z 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 devenv 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

Commit Messages

  • First line of the commit message should be a short (<50 chars) description of the purpose of the commit
    • First word should be one of: feat: for feature, fix: for bugfixes, or break: for breaking changes