USACE / USACE/groundwork

Hooks / components for data from other agencies

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

Nobody has claimed this yet.

discussion
Dominant language
JavaScript
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Description

@adamscarberry @jbkolze
I think it makes sense for us to build hooks/components for this kind of data, if we don't do it so others follow our lead, then they will just do it themselves in haphazard ways. This comes with a couple considerations though:

  1. We need to come up with some disclaimer text that can be used by a consumer of the data/component.
  2. We could add a component that is an orange <TiInfo /> or other icon that pops up the disclaimer when clicked.
  3. We require that when using the hook/display component you must use the disclaimer text or disclaimer component.
  4. I wouldn't try and programmatically enforce this, but the note in the docs should say that we reserve the right to break their sites if they don't follow our usage guidelines.

Originally posted by @willbreitkreutz in https://github.com/USACE/groundwork/issues/49#issuecomment-2093326612

This issue to track a path forward on this conversation.

Contributor guide

Open the contributing guide

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 by reading the discussion referenced from issue #49 and the two comments on this issue, since no implementation files or tests are identified. Define the agreed scope for hooks/components, disclaimer text, the info-icon component, and usage documentation before implementation can be considered complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.