Merge formatting 2024

allenai · Jun 6, 2024 · e3ed9b4 · e3ed9b4
2 parents 65be742 + 60738d9
commit e3ed9b4
Show file tree

Hide file tree

Showing 10 changed files with 147 additions and 76 deletions.
diff --git a/.csharpierignore b/.csharpierignore
@@ -0,0 +1,6 @@
+unity/Dependencies/
+unity/Assets/MagicMirror
+unity/Assets/MessagePack
+unity/Assets/MIConvexHull
+unity/Assets/Priority Queue
+unity/Assets/Plugins
diff --git a/.editorconfig b/.editorconfig
@@ -12,6 +12,7 @@ csharp_prefer_braces = true:error
 
 [*.cs]
 indent_size = 4
+insert_final_newline = true
 
 # Newline settings
 csharp_new_line_before_open_brace = none

diff --git a/.github/workflows/black.yaml b/.github/workflows/black.yaml
@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@23.12.1 # If version changed, update requirements-dev.txt
diff --git a/.lgtm.yml b/.lgtm.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contributing
+
+We welcome contributions from the greater community. If you would like to make such a contributions we recommend first submitting an [issue](https://github.com/allenai/ai2thor/issues) describing your proposed improvement. Doing so can ensure we can validate your suggestions before you spend a great deal of time  upon them. Improvements and bug fixes should be made via a pull request from your fork of the repository at [https://github.com/allenai/ai2thor](https://github.com/allenai/ai2thor).
+
+All code in pull requests should adhere to the following guidelines.
+
+## Found a bug or want to suggest an enhancement?
+
+Please submit an [issue](https://github.com/allenai/ai2thor/issues) in which you note the steps
+to reproduce the bug or in which you detail the enhancement.
+
+## Making a pull request?
+
+When making a pull request we require that any code respects the following guidelines.
+
+### Auto-formatting
+
+All Python and C# must be auto-formatted. To do this, simply run
+```bash
+invoke format
+```
+from the root of the repository.
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,21 @@
+[tool.black]
+line-length = 100
+
+include = '\.pyi?$'
+
+exclude = '''
+(
+      __pycache__
+    | \.git
+    | \.mypy_cache
+    | \.pytest_cache
+    | \.vscode
+    | \.venv
+    | \bdist\b
+    | \bdoc\b
+)
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,8 @@
+pytest
+pytest-timeout
+pytest-cov
+jsonschema
+shapely
+pytest-mock
+dictdiffer
+black==23.12.1 # If version changed, update .github/workflows/black.yaml
diff --git a/requirements-test.txt b/requirements-test.txt
diff --git a/setup.py b/setup.py
@@ -22,7 +22,7 @@ def _read_reqs(relpath):
             ]
 
 REQUIREMENTS = _read_reqs("requirements.txt")
-REQUIREMENTS_TEST = _read_reqs("requirements-test.txt")
+REQUIREMENTS_TEST = _read_reqs("requirements-dev.txt")
 
 setup(
     name="ai2thor",