diff options
author | Alex Richardson <alexrichardson@google.com> | 2023-05-16 14:14:04 -0700 |
---|---|---|
committer | Philipp Tomsich <philipp.tomsich@vrull.eu> | 2023-06-15 16:53:03 +0200 |
commit | 33ef4a33787edae744bacfb85685a41b24dc5ca8 (patch) | |
tree | a3b25dd75e1fb281b0b1205f1131022db30d6420 /CONTRIBUTING.md | |
parent | 9b477812019a78510ebc7f4c7b7efbf378e64a42 (diff) | |
download | sail-riscv-33ef4a33787edae744bacfb85685a41b24dc5ca8.zip sail-riscv-33ef4a33787edae744bacfb85685a41b24dc5ca8.tar.gz sail-riscv-33ef4a33787edae744bacfb85685a41b24dc5ca8.tar.bz2 |
Add a basic pre-commit hook and update CONTRIBUTING.md
Recommend installation of this basic pre-commit hook that ensures that
all files are free of trailing whitespace and have a final newline.
It also checks that no large files are added and that YAML files are valid.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0465fb3..1d9ab14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,3 +27,8 @@ reproducible. Ideally the pull request is accompanied by some form of automated verification that is presented in a way that the reviewers of the pull request can run. It is desirable that the pull request explains how it relates to the existing RISC-V architectural tests. + +We recommend installing pre-commit hooks that ensure certain basic coding +style issues can be detected and fixed before submitting the pull request. +To set up these hooks, install [https://pre-commit.com/](pre-commit) +(e.g. using `pip install --user pre-commit`) and run `pre-commit install`. |