Appsrn 264 documentacion de package y GitHub actions #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
LINK DE TICKET: *
https://janiscommerce.atlassian.net/browse/APPSRN-257
LINK DE SUBTAREA:
https://janiscommerce.atlassian.net/browse/APPSRN-264
DESCRIPCIÓN DEL REQUERIMIENTO: *
Se necesita agregar la documentación sobre el package y los metodos y componentes
DESCRIPCIÓN DE LA SOLUCIÓN: *
Se agregó la documentación sobre los metodos y componentes necesarios del package.
También se agregaron las githubActions para realizar un control de coverage del package, documentación y su posterior publicación.
Se agregaron las firmas en jsdoc de useNotificacion y notificationProvider.
Se agregaron los scripts utilzados en analytics para enviar la notificación a slack sobre una nueva publicación del package
ACLARACIÓN:
No se agregó la documentación de topicsSuscription y topicsUnsuscription porque, como mencionamos en el PR anterior, estas funciones no serán utilizadas a futuro; cuando back termine el trabajo de su lado nosotros utilizaremos otros metodos para suscribir al usuario a eventos y estas utils serán deprecadas.
Tampoco incluí la documentación de utils dentro del readme ya que estas no podrán ser importadas desde el package