Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

61 lines (48 loc) · 2.31 KB
Raw

Contributing to j4-dmenu-destkop

Thank you for considering contributing to j4-dmenu-desktop!

Here are some tips for contributing:

General info

Styleguide

Type names (class names, struct names, using & typedef declarations, enums) use PascalCase. Macros use CAPS_LOCK. Pretty much everything else (function names, variables etc.) use snake_case.

public comes before private in classes.

All members of class must be accessed with this->member inside member functions. This helps disambiguate which variables are local variables and which are member variables.

Header file includes come in this order:

  1. "" include to appropriate header if it's in an implementation file (#include "Dmenu.hh" in Dmenu.cc)
  2. <> includes to external dependencies (Catch2, spdlog...)
  3. <> system includes
  4. "" local includes

They should ideally be separated by a blank line.

J4-dmenu-desktop makes use of clang-format.

Implementation

IO

{fmt} is used where possible. If that isn't possible, C style IO is used. C++ style IO (iostream) isn't used in j4-dmenu-desktop.

Logging

Logging is done by spdlog. At the time of writing, j4-dmenu-desktop makes use of four loglevels: ERROR, WARNING (called WARN in some places), INFO and DEBUG.

// There are printed by default.
SPDLOG_ERROR("Something really bad happened!");
SPDLOG_WARN("j4-dmenu-desktop won't terminate because of this, but the "
            "user should be aware of this nonetheless.");
// These have to be enabled with a flag to be shown.
SPDLOG_INFO("Describe the runtime of j4-dmenu-desktop and print some useful "
            "things.");
SPDLOG_DEBUG("Print debugging info.");

Commandline arguments

There are six places where arguments have to be specified:

  1. in argument handling code of main() (done via getopt)
  2. in --help
  3. in j4-dmenu-destkop.1 manpage
  4. in ZSH completion script etc/_j4-dmenu-desktop
  5. in Fish completion script etc/j4-dmenu-desktop.fish
  6. in Bash completion script etc/j4-dmenu-desktop

When modifying or adding arguments, all six of these have to be updated. This system isn't ideal and might be subject to change in the future.