ORNL / ORNL/GridKit

Add linting

Open
#34 0 comments 1 reaction 2 assignees View on GitHub

@pelesh is already working on this.

Since Dec 9, 2024.

development enhancement
Dominant language
C++
Stars
27
Forks
11
Avg merge
3d 8h
Merged PRs (30d)
23

Description

There are a few style guidelines (#5) that can't be enforced by formatting alone, since they're outside the purview of formatting. For example: identifier naming schemes and error handling. These can be checked by a linter, though, and linting in general isn't a bad idea in a C++ codebase. If we're requiring clang-format as a dev dependency, then we can use clang-tidy, which is also included in clang. This can be added to precommit hooks (#33) and CI (#25).

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.