search

accel-sim / accel-sim-framework

This is the top-level repository for the Accel-Sim framework.
https://accel-sim.github.io
Other
289 stars 110 forks source link

Enforce clang formatting #207

Open JRPan opened 1 year ago

FJShen commented 1 year ago

Plan is to mimic the use of git hooks in GEM5. Python formatting should also be considered. The goal is to standardize the format of committed code.

pre-commit hook must be installed by the programmer. This can be done by adding the installation steps in setup_environment.sh

  1. Format all existing cpp and python code
  2. Lazily check and install pre-commit hooks in setup-env
  3. Enforce format check in Jenkins
  4. Describe formatting requirements in release documentation.