jargonsdev / jargonsdev/jargons.dev

TODO: Handle Error for Existing Branch on Word Submission

Abierto
#52 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

:arrow_upper_right: medium priority :bug: bug :spiral_notepad: todo
Lenguaje dominante
MDX
Estrellas
56
Forks
45
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

When a user submits a new word or edits an existing word in the dictionary, the system should check if the branch already exists before attempting to create a new branch. Currently, if a branch with the same name already exists, the submission process fails without providing a clear error message to the user.

https://github.com/babblebey/jargons.dev/blob/0eeb366b4346c28a400586082fadb331c0ee342f/src/lib/branch.js#L10

Proposed Solution:

  1. Add a check in the submission process to verify if the branch already exists. (but this will assume that a fork has already been created before-hand)
  2. If the branch exists, display a user-friendly error message indicating that the word already exists in the dictionary.
  3. Provide guidance on how to proceed, such as editing the existing word instead of creating a new one.

Additional Notes:

  • Important to state that the proposed solution is pretty much me thinking out loud, I have some thought which really looks like it will change how/when we fork in order to address this in the way I am thinking about
  • Its also important to know how/when we fork too, I can shed more lights on this

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza en src/lib/branch.js, alrededor de la línea 10, y sigue el flujo de envío de palabras, incluido cuándo se crean el fork y la branch. Determina cómo se detecta una branch existente y cómo el envío informa actualmente del fallo. Se considera terminado cuando los envíos duplicados reciben un mensaje claro que indica a los usuarios que editen la palabra existente, con el momento de creación del fork comprendido.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github, javascript, nodejs
Área
api, backend
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.