auxolotl/wiki
20
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Activity
wiki/contributing/formatting/projects.md

2.4 KiB
Raw Blame History

title description published date tags editor dateCreated
Project Standards Code-related standards in Aux true 2024-07-01T19:26:20.836Z markdown 2024-05-05T21:22:30.441Z

Naming

All non-code names, including but not limited to CI Actions, Respositories, and folder and file names inside the project, must follow lower-kebab-case except in cases where a program requires something else.

Names for variables, classes, etc. in code should instead follow our code formatting standards, which are generally that types should be UpperCamelCase, and other variables should be lowerCamelCase.

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
  • First line and main message should have 1 blank newline in between them for ease of reading
  • Main messages
    • Features should have a reason to include the feature, as well as an example of the feature in use (if applicable)
    • Fixes should have what the original bug was, as well as a short summary of the steps that were required to fix it
    • Breaking Changes should have what it breaks, how it breaks it, and a short transition guide

Merging to main with bugs

There are a few reasonable expectations for merges, one is that any change that is made in the project should not include bugs except in extremely rare cases where bugs are unable to be fixed without upstream changes. In this case a bug should be added to the projects kanban board (or similar) with relevant information like the file & code section the bug is in and which upstream issue is causing the bug (if known).

Code

Autoformat specifications for code can be found on our Editorconfig standards page. Please check them there.