Skip to content

Commit

Permalink
Create CONTRIBUTING.md (#427)
Browse files Browse the repository at this point in the history
  • Loading branch information
keflavich authored Aug 18, 2024
1 parent b94a554 commit 3e3a164
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3e3a164

Please sign in to comment.