NSLS2 / NSLS2/nsls2api

Review outstanding TODOs

Open
#271 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
13
Avg merge
1h 17m
Merged PRs (30d)
1

Description

This issue collects the TODO/FIXME comments in the nsls2api application. Review each item and decide whether to complete it, revise it, or remove it.

Partially Done
Open
Completed
Vendored HTMX, Not Local Application Work

The application loads htmx.min.js; htmx.js is the readable vendored source. These TODOs belong upstream and should only be addressed through an HTMX upgrade.

Vendored Font Awesome, Not Local Application Work

Do not modify vendored HTMX or Font Awesome files directly; handle them through upstream dependency upgrades.

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 by reviewing the linked TODO locations in the facility, beamline, proposal, user, and jobs service/API files, separating the local application items from the vendored HTMX and Font Awesome items. Check existing tests and endpoint behavior for each local TODO, then define a focused scope and acceptance criteria; done means each retained TODO has a resolution and outdated or upstream-only items are removed or documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.