llnl / llnl/mrid

Formatting and code style

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

  • Add a .clang-format file that applies our style conventions.
  • Add a GitLab CI job that requires clang-format and black to find no needed changes for C++ and Python code, respectively.
  • Consider adding rules for clang-tidy to check naming conventions, as well. (readability-identifier-naming)
  • Consider using pre-commit to apply formatting fixes automatically.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the .clang-format target and the GitLab CI job described in the checklist, then review the proposed clang-tidy naming rule and pre-commit option. Clarify which checklist items are in scope; done means the agreed formatting and style checks require no needed changes for the C++ and Python code.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, gitlab, python
Domain
build-system, ci-cd, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.