-
Notifications
You must be signed in to change notification settings - Fork 0
MPT-16808: add CodeRabbit config and copilot-instructions #184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json | ||
| remote_config: | ||
| url: "https://raw.githubusercontent.com/softwareone-platform/swo-extension-playground/refs/heads/main/.coderabbit.yaml" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| description: 'Python coding conventions and guidelines' | ||
| applyTo: '**/*.py' | ||
| --- | ||
|
|
||
| # Python Coding Conventions | ||
|
|
||
| ## General Instructions | ||
| - All configuration **must be provided via environment variables**. | ||
| - Do not hardcode configuration values. | ||
| - Write maintainable, readable, and predictable code. | ||
| - In `pyproject.toml`: | ||
| - Use `*` for **minor versions only** | ||
| ✅ `django==4.2.*` | ||
| ❌ `django==^4.2.2` | ||
|
|
||
| - Use consistent naming conventions and follow language-specific best practices. | ||
|
|
||
| ## Python Instructions | ||
| - Use type annotations (PEP 484) - except in the `tests/` folder. | ||
| - All public functions, methods, and classes **must include [Google-style docstrings](https://google.github.io/styleguide/pyguide.html)**. | ||
| - **Do not add inline comments**; rely on clear code and docstrings instead. | ||
| - Function and variable names must be explicit and intention-revealing. | ||
| - `pyproject.toml` is the source of truth for code quality rules. Generated code must not violate any configured rules. | ||
| - **ruff** is the primary linter for general Python style and best practices. | ||
| - **flake8** is used exclusively to run: | ||
| - `wemake-python-styleguide` - Enforces strict Python coding standards ([docs](https://wemake-python-styleguide.readthedocs.io/en/latest/)) | ||
| - `flake8-aaa` - Validates the AAA pattern in tests | ||
| - Follow PEP 8 unless explicitly overridden by ruff. | ||
| - Prefer simple, explicit code over clever or compact implementations. | ||
|
|
||
| ## Testing | ||
| - Use pytest only. | ||
| - Tests must be written as **functions**, not classes. | ||
| - Test files and functions must use the `test_` prefix. | ||
| - Follow ***AAA(Arrange - Act - Assert)*** strictly. See the [flake8-aaa documentation](https://flake8-aaa.readthedocs.io/en/stable/index.html). | ||
| - Do **not** use `if` statements or branching logic inside tests. | ||
| - Prefer fixtures over mocks whenever possible. | ||
| - Avoid duplicating test logic; extract shared setup into fixtures. | ||
| - Use `mocker` only when mocking is unavoidable. | ||
| - Never use `unittest.mock` directly. | ||
| - Always use `spec` or `autospec` when mocking. | ||
| - Use `@pytest.mark.parametrize` tests when testing permutations of the same behavior. | ||
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.