Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit config and documentation #221

Merged
merged 2 commits into from
Apr 17, 2024
Merged

Conversation

brsm3129
Copy link
Collaborator

@brsm3129 brsm3129 commented Apr 9, 2024

  • Tickets addressed: MAXGNC-779
  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

A pre-commit config file was added along with documentation.

Verification

There should be no change in functionality so no new tests are needed.

Documentation

No documentation was invalidated but new documentation was added to CONTRIBUTING.md

Future work

  • We can add clang-format to the pre-commit hooks.
  • Consider running pre-commit on all files before merging this PR into develop

@brsm3129 brsm3129 requested a review from patkenneally April 9, 2024 19:07
@brsm3129 brsm3129 self-assigned this Apr 9, 2024
@brsm3129 brsm3129 force-pushed the feature/pre-commit branch 3 times, most recently from cacfabd to 25ce09e Compare April 17, 2024 18:55
@brsm3129 brsm3129 force-pushed the feature/pre-commit branch from 25ce09e to 2bf8432 Compare April 17, 2024 18:57
@brsm3129 brsm3129 changed the title Feature/pre commit Add pre-commit config and documentation Apr 17, 2024
@patkenneally patkenneally merged commit c87c23d into develop Apr 17, 2024
2 checks passed
@patkenneally patkenneally deleted the feature/pre-commit branch April 17, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants