jargonsdev / jargonsdev/jargons.dev
Allow Submitting a Word Addition Request When Word is Not Found
Nessuno ha ancora preso questa issue.
- Lingua principale
- MDX
- Stelle
- 56
- Fork
- 45
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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](https://github.com/jargonsdev/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 issue should be created using the [jargons.dev GitHub App](https://github.com/apps/jargons-dev) instance.
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)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da components/islands/search.jsx e esamina la PR #98 per comprendere il Contribution CTA esistente e il flusso dei risultati di ricerca. Segui il modo in cui gli utenti autenticati e la jargons.dev GitHub App possono creare issues, quindi verifica che il flusso crei una issue nel repository contenente la parola cercata e il contesto per entrambi i percorsi di autenticazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github, javascript, node.js, react
- Ambito
- api, authentication, frontend
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100