UTDNebula/utd-trends

[Internal] Modular API's (in components)

Open

#177 opened on Aug 31, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (35 forks)auto 404
Good First IssueMultiple EngineersStatus: On HoldType: DocumentationType: Internal

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (PR metrics pending)

Description

Overview of Proposed Changes

What: Ensure all API calls are occurring in their respective components Why: Modularity, cleaner code

Details

  • Write/update documentation about how/which APIs are called in Trends
  • Identify API calls outside of components
  • Move outstanding stray API calls to inside components
  • Write documentation on how and where Trends is using the APIs

Contributor guide

Research direction
Examine the codebase to identify API calls currently made outside of components, particularly in Trends, and move them into the appropriate components. Update documentation accordingly.
Tech stack
typescript
Domain
frontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60