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

Audit implementation of all controllers against "Guidelines for Writing Controllers" #4578

Open
desi opened this issue Aug 1, 2024 · 1 comment
Labels
team-wallet-framework type-research A task which outcome is information rather than implementation

Comments

@desi
Copy link
Contributor

desi commented Aug 1, 2024

Motivation

Some of our controllers currently do not fulfill their intended specifications correctly, which may affect downstream clients where the controllers are used.

To understand the extent of the problem and its impact, we should perform an audit on all controllers, evaluating whether their implementation of the BaseController API is both complete and correct, and documenting any points for improvement. Tickets should be created for any fix suggestions and communicated to the appropriate codeowners.

We now have documentation that we can reference as a source of truth during this process.

Acceptance Criteria

  • Tickets are created for auditing each controller.
  • All controllers are audited and reports left in the corresponding tickets (a simple "all-clear" should do if no problems are found).
  • Tickets are created for fixing all issues documented in the reports, and these are assigned to the appropriate codeowners.

References

@desi
Copy link
Contributor Author

desi commented Aug 1, 2024

@MajorLift please fill in details here.

@MajorLift MajorLift added the type-research A task which outcome is information rather than implementation label Aug 2, 2024
@MajorLift MajorLift changed the title Placeholder - Audit implementation of core controller Audit implementation of all controllers against "Guidelines for Writing Controllers" Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-wallet-framework type-research A task which outcome is information rather than implementation
Projects
None yet
Development

No branches or pull requests

2 participants