jargonsdev / jargonsdev/jargons.dev

Allow Submitting a Word Addition Request When Word is Not Found

Offen
#102 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

:arrow_upper_right: medium priority :sparkles: enhancement
Vorherrschende Sprache
MDX
Sterne
56
Forks
45
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

We need a feature that allows users to submit a request for word addition to the dictionary when the searched word is not found. This feature will enhance user engagement and ensure that missing terms can be added to jargons.dev efficiently.

When a word is searched and not found in the dictionary, a prompt should appear, offering users the option to request the addition of the word. The request should create an issue on the jargons.dev repository using the following criteria:

  • If the user is authenticated:

    • The issue should be created using the user's GitHub account, and the user's profile should be associated with the issue.
  • If the user is not authenticated:

The link to initiate this word addition request can be displayed in the Contribution CTA section of the search dialog, which may have been introduced in PR #98.

Acceptance Criteria:
  • Display a message prompting the user to request word addition when a search result is not found.
  • Allow users to choose whether to authenticate with their GitHub account or proceed using the jargons.dev GitHub App.
  • If authenticated, submit the request to the jargons.dev repository using the user's profile.
  • If not authenticated, submit the request using the jargons.dev GitHub App.
  • Ensure the request is posted as an issue on the jargons.dev repository with details of the word and any relevant context.
  • Add the link to initiate this request in the Contribution CTA section of the search dialog.
Relevant File:

The Contribution CTA part can be found in the components/islands/search.jsx component, where it interacts with the search result.

Related PR:
  • PR #98 (for reference on the Contribution CTA component)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit components/islands/search.jsx und sieh dir PR #98 an, um den bestehenden Contribution CTA und den Ablauf der Suchergebnisse zu verstehen. Verfolge, wie authentifizierte Benutzer und die jargons.dev GitHub App Issues erstellen können, und überprüfe anschließend, dass der Ablauf für beide Authentifizierungspfade ein Repository-Issue erstellt, das das gesuchte Wort und den Kontext enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github, javascript, node.js, react
Bereich
api, authentication, frontend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.