jargons.dev icon indicating copy to clipboard operation
jargons.dev copied to clipboard

Allow Submitting a Word Addition Request When Word is Not Found

Open babblebey opened this issue 1 year ago • 3 comments

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)

babblebey avatar Sep 21 '24 19:09 babblebey

Would like to work on this can you assign it to me

TRIPLE-ADE avatar Nov 29 '24 13:11 TRIPLE-ADE

Let me take on this task, please assign it to me

ShyneADL avatar Jan 19 '25 14:01 ShyneADL

Hi @ShyneADL 👋🏾,

You can only be assigned one issue at a time, you still have one assigned to you 🫣

Plus, this issue isn't exactly ready to be worked on yet, as it relies on a certain opened PR to be merged (see related PR in description)

Kindly note @TRIPLE-ADE

babblebey avatar Jan 22 '25 08:01 babblebey