Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow Submitting a Word Addition Request When Word is Not Found #102

Open
6 tasks
babblebey opened this issue Sep 21, 2024 · 0 comments
Open
6 tasks

Allow Submitting a Word Addition Request When Word is Not Found #102

babblebey opened this issue Sep 21, 2024 · 0 comments
Labels
↗️ medium priority This issue is crucial ✨ enhancement New feature or request

Comments

@babblebey
Copy link
Member

babblebey commented Sep 21, 2024

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:

@babblebey babblebey added ✨ enhancement New feature or request ↗️ medium priority This issue is crucial labels Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
↗️ medium priority This issue is crucial ✨ enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant