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

Task: Standardize Environment Variable Naming Conventions and Error Handling #343

Open
Luka-Loncar opened this issue Jan 20, 2025 · 0 comments
Labels
enhancement New feature or request task

Comments

@Luka-Loncar
Copy link
Collaborator

Luka-Loncar commented Jan 20, 2025

Description

We need to establish consistent organization-wide standards for environment variable naming and error handling. This issue is meant to facilitate discussion and agreement on these standards during the Tuesday planning meeting.
Current Situation

Environment Variable Naming:

  • Currently using multiple different naming patterns across our codebase
  • Examples of current variations (for discussion purposes):
#Some current patterns in use:
Simple prefix pattern: API_KEY, API_URL
Service-specific pattern: MASA_PROTOCOL_NODE_API
Extended patterns: MASA_PROTOCOL_NODE_API_PATH
  • Need to agree on a consistent approach

Error Handling:

  • Limited error handling currently in place (fetch_posts_from_api)
  • Basic retry logic implemented in some places
  • Opportunity to establish more robust standards

Discussion Points

  1. Environment Variable Naming:
  • What level of specificity do we need in our naming?
  • How to handle service-specific variables?
  • Considerations for maintainability and clarity
  • Backward compatibility and migration approach
  1. Error Handling Standards:
  • What types of errors should we handle?
  • Standard approaches for different scenarios
  • Logging and error surfacing requirements
  • Retry strategies

Goals

  • Reach consensus on naming convention standards
  • Define clear error handling patterns
  • Create plan for implementing agreed-upon standards
  • Establish documentation requirements

Questions for Tuesday Planning

  • What naming patterns work best for our use cases?
  • How detailed should our naming hierarchy be?
  • What are our error handling priorities?
  • How do we want to approach the migration?
@Luka-Loncar Luka-Loncar added enhancement New feature or request task labels Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request task
Projects
None yet
Development

No branches or pull requests

1 participant