NWChemEx / NWChemEx/.github

Other C++ Conventions

Open
#16 1 comment 0 reactions 1 assignee View on GitHub

@ryanmrichard is already working on this.

Since Oct 7, 2021.

documentation
Dominant language
Dockerfile
Stars
1
Forks
2
Avg merge
22m
Merged PRs (30d)
4

Description

We have a list of C++ coding conventions here, but there's other aspects of the C++ source code design which should be standardized. I'm starting this issue to keep track of such things.

  • use of _t and _type suffixes for typedefs
  • decide whether to use _ as prefix or suffix on protected/private members
  • use m_ prefix for members
  • insist on out-of-line definitions for functions that are longer than one line
  • put out-of-line definitions to be inline'd in .ipp files
  • names of polymorphic copy and comparisons
  • how to reference types from dependencies
    • some of our repos define a header types.hpp do we want to standardize it?
  • directory structures?
  • when to use nested namespaces
  • where to put traits
  • when to start new files

This should be compared with the C++ Core Guidelines for consistency.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.