Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

30 lines (25 loc) · 1.44 KB

Contributing

Contributing to Finch is easy: just open a pull request. Make main the destination branch on the Finch repository and allow edits from maintainers in the pull request.

Your pull request must pass use the coding style from .clang-format (enforced with clang-format-14), include reasonable documentation, and be reviewed by at least one Finch developer.

pre-commit is a useful tool for ensuring feature branches are ready for review by running automatic checks locally before a commit is made. Installation details (once per system) and activation details (once per repo) are available.

Coding style includes:

  • Camel case template parameters (NewTemplateType)
  • Camel case class names (NewClassName)
  • Lower camel case function names (newFunctionName)
  • Lower case, underscore separated variables (new_variable_name)
    • Class members which are private are followed by an underscore (private_class_variable_)
  • Class member type aliases use lower case, underscore separated names (using integer_type = int;)

Naming conventions for folders, files, libraries, and executables include:

  • Lower case, underscore separated folders (new_folder_name)
  • Camel case file names (NewFileName)
  • Camel case library names (NewLibraryName)
  • Lower case, underscore separated executable names (new_executable_name)