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.

Sign up for GitHub

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

Add guidelines for writing controllers #4110

Merged
merged 17 commits into from
Sep 2, 2024
Merged

Add guidelines for writing controllers #4110

merged 17 commits into from
Sep 2, 2024

Commits on Jul 8, 2024

  1. Add guidelines for writing controllers 

    So far we have not have any documentation on how to write controllers
the BaseController v2 way. These guidelines aim to fill in the missing
pieces. Note that while each guideline has examples, we are still
missing a complete example controller file which demonstrates all of the
guidelines in one go. That will come in a future PR.
    @mcmire
    mcmire committed Jul 8, 2024
    Configuration menu
    Copy the full SHA
    271cbd6 View commit details
    Browse the repository at this point in the history

Commits on Jul 9, 2024

  1. AccountsControllerGetState -> AccountsControllerGetStateAction 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    8ef4993 View commit details
    Browse the repository at this point in the history

  2. Tweak wording in first section 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    35db85b View commit details
    Browse the repository at this point in the history

  3. Fix typo 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    73cf66f View commit details
    Browse the repository at this point in the history

  4. Use stronger language for exporting default state, and explain why no… 

    …t a simple variable

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    002a914 View commit details
    Browse the repository at this point in the history

  5. Clarify how action identifiers should be named 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    cb5242a View commit details
    Browse the repository at this point in the history

  6. Tweak name of internal action types guideline 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    f79c325 View commit details
    Browse the repository at this point in the history

  7. Tweak name of action types guideline 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    635ff55 View commit details
    Browse the repository at this point in the history

  8. Reword 'options bag' guideline slightly

    @mcmire
    mcmire committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    b4f335f View commit details
    Browse the repository at this point in the history

  9. Clarify name of the default state object

    @mcmire
    mcmire committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    92fca54 View commit details
    Browse the repository at this point in the history

  10. Add section on metadata

    @mcmire
    mcmire committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    545e90e View commit details
    Browse the repository at this point in the history

  11. Merge branch 'main' into add-controller-guidelines

    @mcmire
    mcmire authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    88c8f38 View commit details
    Browse the repository at this point in the history

  12. Tweak example

    @mcmire
    mcmire committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    7bea382 View commit details
    Browse the repository at this point in the history

  13. Apply suggestions 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    6dbedbb View commit details
    Browse the repository at this point in the history

  14. Update docs/writing-controllers.md 

    Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
    @mcmire @MajorLift
    mcmire and MajorLift authored Jul 9, 2024
    Configuration menu
    Copy the full SHA
    229cf20 View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2024

  1. Merge branch 'main' into add-controller-guidelines

    @mikesposito
    mikesposito authored Aug 26, 2024
    Configuration menu
    Copy the full SHA
    1e9577b View commit details
    Browse the repository at this point in the history

Commits on Sep 2, 2024

  1. Merge branch 'main' into add-controller-guidelines

    @mikesposito
    mikesposito authored Sep 2, 2024
    Configuration menu
    Copy the full SHA
    cd3c95f View commit details
    Browse the repository at this point in the history