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

Improve Project Onboarding and Test Coverage #50

Open
1 of 4 tasks
jdnichollsc opened this issue Jan 15, 2025 · 0 comments · May be fixed by #51
Open
1 of 4 tasks

Improve Project Onboarding and Test Coverage #50

jdnichollsc opened this issue Jan 15, 2025 · 0 comments · May be fixed by #51

Comments

@jdnichollsc
Copy link

jdnichollsc commented Jan 15, 2025

Description:
The project needs better onboarding documentation and test coverage to help new contributors understand and maintain the codebase.

Current Issue: Lack of docs and limited test coverage for transaction parsing and error cases

Proposed Changes:

Documentation:

  • Create docs about:
    • Project structure overview
    • Document high-level architecture
    • Document proto structure decisions
    • Explain type system design choices
    • Development environment setup guide
    • Common troubleshooting steps

Test Coverage:

  • Add integration tests for:
    • Transaction parsing with different proto versions
    • Error handling scenarios
    • Type conversions and transformations
  • Create mock data fixtures for testing
  • Add unit tests for core functionality

Expected Outcome:

  • Easier onboarding for new contributors
  • More robust codebase with better test coverage
  • Clear documentation of project architecture and dependencies
@jdnichollsc jdnichollsc linked a pull request Jan 15, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant