From 3e3a164d87b579502a69ffecd1cf15e5815e6f5e Mon Sep 17 00:00:00 2001 From: Adam Ginsburg Date: Sun, 18 Aug 2024 14:08:00 -0600 Subject: [PATCH] Create CONTRIBUTING.md (#427) --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1e4dbdc7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +Contributing to the ACES software repository +============================================ + +All code is run through `flake8` code style checks before being merged. This is primarily to ensure that code is syntactically valid, but it also helps keep the data uniform. + +The check that gets run is `flake8 aces --count --max-line-length=250 --ignore=W504,E265,F401,W292,E261,E262,E124,W503,E266` (https://github.com/ACES-CMZ/reduction_ACES/blob/main/tox.ini#L100). That may be updated in the future, so be sure to check tox.ini if you're getting odd results.