ORNL / ReSolve

Library of GPU-resident linear solvers
Other
51 stars 1 forks source link

clarify style guidelines in `CONTRIBUTING.md` / set up `clang-format` #150

Open superwhiskers opened 1 month ago

superwhiskers commented 1 month ago

related to #54 / #82, albeit it deserves a dedicated pull request to unbundle it from the addition of pre-commit

rationale

currently, CONTRIBUTING.md is insufficiently precise in some ways and the repository's existing .clang-format file is not used and does not match the conventions within CONTRIBUTING.md exactly. clarifying the style guidelines and setting up .clang-format would help maintain a consistent style across the codebase and potentially make it more welcoming to newcomers

considerations

initial suggestions

superwhiskers commented 1 month ago

some additional comments:

pelesh commented 1 month ago

@cameronrutherford and @ryandanehy, please chime in.

CC: @kswirydo

cameronrutherford commented 1 month ago

Closed #82. I think we could close #54 without doing C++ formatting, and then have the clang-format and clang-tidy hooks added in another PR/Issue.

+1 to the clang-tidy suggestion. Might be worth discussion in another issue and closing out one thing at a time.