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

[Core] Make viper great again #907

Open
11 tasks
Olshansk opened this issue Jul 14, 2023 · 0 comments
Open
11 tasks

[Core] Make viper great again #907

Olshansk opened this issue Jul 14, 2023 · 0 comments
Labels
bug Something isn't working - expected behaviour is incorrect documentation Improvements or additions to documentation infra Core infrastructure - not protocol related tooling tooling to support development, testing et al

Comments

@Olshansk
Copy link
Member

Objective

Cleanup, improve and clarify how viper work and is used throughout the codebase.

Origin Document

It started in #902 with this comment:

Screenshot 2023-07-14 at 3 50 53 PM

Then it crossed over in #891 with this comment

Screenshot 2023-07-14 at 3 50 59 PM

Goals

  • Clearer separation between CLI and API code
  • Parsing the config consistently in all CLI commands.
  • Handling flags consistently in all commands.

Deliverable

  • Refactor how viper is used to make it clear and understandable
  • Update the documentation for how & why we use viper in a certain way

Non-goals / Non-deliverables

  • Removing viper as a dependency

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)
  • Update relevant source code tree explanations
  • Add or update any relevant or supporting mermaid diagrams

Testing Methodology

  • Task specific tests or benchmarks: make ...
  • New tests or benchmarks: make ...
  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md
  • k8s LocalNet: verify a k8s LocalNet is still functioning correctly by following the instructions here

Creator: @Olshansk
Co-Owners: @bryanchriswhite

@Olshansk Olshansk added bug Something isn't working - expected behaviour is incorrect documentation Improvements or additions to documentation infra Core infrastructure - not protocol related tooling tooling to support development, testing et al labels Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working - expected behaviour is incorrect documentation Improvements or additions to documentation infra Core infrastructure - not protocol related tooling tooling to support development, testing et al
Projects
Status: Backlog
Development

No branches or pull requests

1 participant