NatLabRockies / NatLabRockies/developer.nlr.gov

Return monthly data with months as integers rather than abbreviated strings

Open
#3 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ux-feedback
Dominant language
HTML
Stars
60
Forks
57
Avg merge
1d 21h
Merged PRs (30d)
3

Description

Feedback from our API Usability Testing: In the solar resource output, we return monthly data as an object where the keys are month abbreviations (eg, "jan", "mar"). It was suggested that we use integers for months instead (so 1-12), which is a little more universal, and also makes things easier to sort on or iterate through.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the solar resource output described in the linked API documentation and locate the implementation that builds its monthly data object. Check existing tests or fixtures for that response, then confirm the completed output uses month keys 1 through 12 consistently and remains sortable and iterable.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.