sillsdev / sillsdev/TheCombine

Improve Sense, Gloss field names

Open
#1,201 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

maintenance
Dominant language
TypeScript
Stars
22
Forks
10
Avg merge
2d 2h
Merged PRs (30d)
9

Description

  • Rename Sense.Accessiblity as is has nothing to do with the usual meaning of accessibility. It could possibly be changed to Sense.Status to match the fact that its type is the Status enum
  • Rename the State enum used for Words and Senses to Status as it's unrelated to the central react/redux concept of state. (#2019)
  • Rename Gloss.Def, since "Gloss" and "Definition" are related but distinct linguistic terms, and we may need to support both in the future.

These will require global updates to database entries.

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 locating all uses of Sense.Accessiblity, the State enum, and Gloss.Def in TheCombine, including the database entries mentioned in the issue. Confirm the intended replacement names for the remaining two fields, then update every reference and verify that existing database data remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
database
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.