From 72c6982aa969e883a334e0290a462cd7b23480c1 Mon Sep 17 00:00:00 2001 From: Leonid Meleshin Date: Sun, 22 Oct 2023 00:14:08 +0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=91=E2=80=8D=F0=9F=92=BB=20(Sweep):=20?= =?UTF-8?q?update=20testing=20description?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- sweep.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/sweep.yaml b/sweep.yaml index 21fd0c5..98f1738 100644 --- a/sweep.yaml +++ b/sweep.yaml @@ -9,7 +9,7 @@ rules: - "There should be no debug log or print statements in production code." - "All functions should have parameters and output annotated with type hints. Use list, tuple and dict instead of typing.List, typing.Tuple and typing.dict." - "Leftover TODOs in the code should be handled." - - "All new business logic should have corresponding unit tests in the same directory. For example, sweepai/api_test.py tests sweepai/api.py. Use unittest and unittest.mock as required." + - "All new business logic should have corresponding unit tests in the same directory. For example, tests/utils/string_test.py tests aicord/utils/string.py. We use pytest for tests." - "Any clearly inefficient or repeated code should be optimized or refactored." - "Remove any comments before code that are obvious. For example `# this prints hello world; print('hello world')`." - "Avoid duplicating code. Refactor and update duplicate code to improve maintainability." @@ -27,7 +27,7 @@ gha_enabled: True # Example: # # description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8. -description: 'Aicord is a python 3.10 project. Main bot functianality is in aicord/discord/cogs modules. Each cog reposents a category of commands. All imports should be global (like `import sweepai.utils.github_utils`). Write unit tests in the same directory as their corresponding code, i.e. aicord/utils/string_test.py tests aicord/utils/string.py. We use unittest and unittest.mock for tests. Never use wildcard imports.' +description: 'Aicord is a python 3.10 project. Main bot functianality is in aicord/discord/cogs modules. Each cog reposents a category of commands. All imports should be global (like `import sweepai.utils.github_utils`). Never use wildcard imports. Write unit tests in the same directory as their corresponding code, i.e. tests/utils/string_test.py tests aicord/utils/string.py. We use pytest for tests.' # This sets whether to create pull requests as drafts. If this is set to True, then all pull requests will be created as drafts and GitHub Actions will not be triggered. draft: False @@ -45,6 +45,7 @@ docs: - LangChain: ["https://python.langchain.com/docs/get_started/introduction", "We use LangChain for LLM"] - Pycord: ["https://docs.pycord.dev/en/stable/", "We use Pycord for Discord API and bot commands"] - gitmoji: ["https://gitmoji.dev/specification", "We use gitmoji for commit messages"] + - pytest: ["https://docs.pytest.org/en/7.4.x/", "We use pytest for unit tests"] # Sandbox executes commands in a sandboxed environment to validate code changes after every edit to guarantee pristine code. For more details, see the [Sandbox](./sandbox) page. sandbox: