Skip to content
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

Feature/20231204-volunteer-onboarding #55

Merged
merged 15 commits into from
Jan 24, 2024

Conversation

delano
Copy link
Contributor

@delano delano commented Jan 24, 2024

Type

enhancement, bug_fix, documentation, configuration changes


Description

  • Added and updated comments in the Profile and Role models for better clarity and readability.
  • Introduced a custom manager in the User model to streamline user creation.
  • Created a new Vue component for request forms and fixed a typo in the ApplicationPage layout.
  • Updated GitHub Actions workflow, removed obsolete Ruff configuration, and updated Trunk configuration.
  • Added @trunkio/launcher as a dev dependency and generated the corresponding lockfile.
  • Updated the requirements files with clearer instructions and added a new dependency to avoid a deprecation warning.
  • Updated various Python package versions to their latest.
  • Added a script for running a debugging proxy and added comprehensive Ruff configuration to pyproject.toml.

Changes walkthrough

Relevant files
Enhancement
4 files
profile.py
Enhance Profile Model Comments and Readability                     

apps/api/afbcore/models/users/profile.py

  • Added comments to clarify the necessity of address validation and the
    issues with clients not knowing their postal codes.
  • Reformatted comments for better readability.
  • +16/-9   
    user.py
    User Model Custom Manager Addition and Comment Update       

    apps/api/afbcore/models/users/user.py

  • Added a custom manager to the User model for creating users and
    superusers.
  • Updated comments to reflect changes and added a note about the custom
    manager.
  • +18/-15 
    NewRequestForm.vue
    New Vue Component for Request Form                                             

    apps/ui/src/components/forms/NewRequestForm.vue

    • Created a new Vue component template for NewRequestForm.
    +13/-1   
    run_proxy
    Add Debugging Proxy Script                                                             

    bin/run_proxy

  • Added a script for running a Man in the Middle Proxy & Web UI for
    debugging.
  • +23/-0   
    Bug_fix
    2 files
    role.py
    Role Model Import Order Fix and Comment Enhancement           

    apps/api/afbcore/models/users/role.py

  • Fixed import order and added a more descriptive comment for the name
    attribute.
  • Removed duplicate __str__ method.
  • +5/-7     
    ApplicationPage.vue
    Typo Fix in ApplicationPage Vue Layout                                     

    apps/ui/src/layouts/ApplicationPage.vue

    • Fixed a typo in the footer tag.
    +1/-1     
    Formatting
    1 files
    django.yml
    Cleanup Whitespace in Django GitHub Actions Workflow         

    .github/workflows/django.yml

    • Removed unnecessary whitespace at the beginning of the file.
    +0/-1     
    Configuration changes
    3 files
    .ruff.toml
    Remove Obsolete Ruff Configuration                                             

    .ruff.toml

    • Removed the entire .ruff.toml configuration file.
    +0/-26   
    trunk.yaml
    Trunk Configuration Update and Plugin Adjustments               

    .trunk/trunk.yaml

  • Updated CLI and plugin versions.
  • Disabled black, isort, and autoflake plugins.
  • +10/-8   
    pyproject.toml
    Add Ruff Configuration to Pyproject.toml                                 

    pyproject.toml

    • Added a comprehensive Ruff configuration to pyproject.toml.
    +58/-0   
    Dependencies
    3 files
    package.json
    Add Trunk Launcher Dev Dependency                                               

    apps/api/package.json

    • Added @trunkio/launcher as a dev dependency.
    +5/-0     
    pnpm-lock.yaml
    Generate Lockfile for New Dependency                                         

    apps/api/pnpm-lock.yaml

    • Generated lockfile for new dev dependency.
    +17/-0   
    requirements.txt
    Update Python Dependencies to Latest Versions                       

    apps/api/requirements.txt

    • Updated various Python package versions.
    +56/-30 
    Documentation
    1 files
    requirements.in
    Update Requirements File Instructions and Add Dependency 

    apps/api/requirements.in

  • Updated comments for clarity and added instructions for pip-compile.
  • Added torchsde>=0.2.6 to avoid a deprecation warning.
  • +27/-13 

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    delano added 13 commits December 5, 2023 18:09
    Signed-off-by: delano <[email protected]>
    Signed-off-by: delano <[email protected]>
    There's some recent issue with ruff failing on its own ruff.toml
    config file. Renaming the file is an easy workaround for now.
    Jinja vulnerable to HTML attribute injection when passing user input as keys to xmlattr filter. Current version is vulnerable: 3.1.2. Patch available: upgrade to 3.1.3 or higher.
    - Moved `NewRequestForm.vue` to a dedicated `forms` folder for better organization.
    - This change enhances maintainability by grouping form components together, simplifying navigation and development within the codebase.
    Used in dev for debugging VSCode extensions. Not used by any API or UI code and even when it's running, it's only used by VSCode after settings are manually updated.
    @delano delano self-assigned this Jan 24, 2024
    @delano delano merged commit fbd9c84 into main Jan 24, 2024
    0 of 2 checks passed
    @delano delano deleted the feature/20231204-volunteer-onboarding branch January 24, 2024 21:30
    @delano
    Copy link
    Contributor Author

    delano commented Mar 25, 2024

    /describe

    Copy link
    Contributor

    qodo-merge-pro bot commented Mar 25, 2024

    PR Description updated to latest commit (79312fc)

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Changes walkthrough

    Enhancement
    profile.py (+16/-9)
    Enhance Profile Model Comments and Readability                     

    apps/api/afbcore/models/users/profile.py

  • Added comments to clarify the necessity of address validation and the
    issues with clients not knowing their postal codes.
  • Reformatted comments for better readability.
  • user.py (+18/-15)
    User Model Custom Manager Addition and Comment Update       

    apps/api/afbcore/models/users/user.py

  • Added a custom manager to the User model for creating users and
    superusers.
  • Updated comments to reflect changes and added a note about the custom
    manager.
  • NewRequestForm.vue (+13/-1)
    New Vue Component for Request Form                                             

    apps/ui/src/components/forms/NewRequestForm.vue

    • Created a new Vue component template for NewRequestForm.
    run_proxy (+23/-0)
    Add Debugging Proxy Script                                                             

    bin/run_proxy

  • Added a script for running a Man in the Middle Proxy & Web UI for
    debugging.
  • Bug_fix
    role.py (+5/-7)
    Role Model Import Order Fix and Comment Enhancement           

    apps/api/afbcore/models/users/role.py

  • Fixed import order and added a more descriptive comment for the name
    attribute.
  • Removed duplicate __str__ method.
  • ApplicationPage.vue (+1/-1)
    Typo Fix in ApplicationPage Vue Layout                                     

    apps/ui/src/layouts/ApplicationPage.vue

    • Fixed a typo in the footer tag.
    Formatting
    django.yml (+0/-1)
    Cleanup Whitespace in Django GitHub Actions Workflow         

    .github/workflows/django.yml

    • Removed unnecessary whitespace at the beginning of the file.
    Configuration changes
    .ruff.toml (+0/-26)
    Remove Obsolete Ruff Configuration                                             

    .ruff.toml

    • Removed the entire .ruff.toml configuration file.
    trunk.yaml (+10/-8)
    Trunk Configuration Update and Plugin Adjustments               

    .trunk/trunk.yaml

  • Updated CLI and plugin versions.
  • Disabled black, isort, and autoflake plugins.
  • pyproject.toml (+58/-0)
    Add Ruff Configuration to Pyproject.toml                                 

    pyproject.toml

    • Added a comprehensive Ruff configuration to pyproject.toml.
    Dependencies
    package.json (+5/-0)
    Add Trunk Launcher Dev Dependency                                               

    apps/api/package.json

    • Added @trunkio/launcher as a dev dependency.
    pnpm-lock.yaml (+17/-0)
    Generate Lockfile for New Dependency                                         

    apps/api/pnpm-lock.yaml

    • Generated lockfile for new dev dependency.
    requirements.txt (+56/-30)
    Update Python Dependencies to Latest Versions                       

    apps/api/requirements.txt

    • Updated various Python package versions.
    Documentation
    requirements.in (+27/-13)
    Update Requirements File Instructions and Add Dependency 

    apps/api/requirements.in

  • Updated comments for clarity and added instructions for pip-compile.
  • Added torchsde>=0.2.6 to avoid a deprecation warning.
  • @delano
    Copy link
    Contributor Author

    delano commented Mar 25, 2024

    /help

    Copy link
    Contributor

    PR Agent Walkthrough

    🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more.

    Here is a list of tools you can use to interact with the PR Agent:

    ToolDescriptionInvoke Interactively 💎

    DESCRIBE

    Generates PR description - title, type, summary, code walkthrough and labels
    • Run

    REVIEW

    Adjustable feedback about the PR, possible issues, security concerns, review effort and more
    • Run

    IMPROVE

    Code suggestions for improving the PR.
    • Run

    ANALYZE 💎

    Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
    • Run

    UPDATE CHANGELOG

    Automatically updates the changelog.
    • Run

    ADD DOCUMENTATION 💎

    Generates documentation to methods/functions/classes that changed in the PR.
    • Run

    ASK

    Answering free-text questions about the PR.

    [*]

    GENERATE CUSTOM LABELS

    Generates custom labels for the PR, based on specific guidelines defined by the user

    [*]

    TEST 💎

    Generates unit tests for a specific component, based on the PR code change.

    [*]

    CI FEEDBACK 💎

    Generates feedback and analysis for a failed CI job.

    [*]

    CUSTOM SUGGESTIONS 💎

    Generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.

    [*]

    SIMILAR ISSUE

    Automatically retrieves and presents similar issues.

    [*]

    (1) Note that each tool be triggered automatically when a new PR is opened, or called manually by commenting on a PR.

    (2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the /ask tool, you need to comment on a PR: /ask "<question content>". See the relevant documentation for each tool for more details.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    Status: ✔️ Done
    Development

    Successfully merging this pull request may close these issues.

    1 participant