Documentation issue: usage with TypeScript is wrong
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
Comienza con la sección TypeScript Usage del README y compárala con la documentación del website, ya que el issue identifica los ejemplos que entran en conflicto. Actualiza el contenido del README publicado en NPM y verifica que la sección renderizada muestre correctamente el import documentado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The "TypeScript Usage" section on NPM says that the package needs to be imported as default import:
import Jimp from "jimp";
But it's incorrect. The correct import is a named import like this:
import { Jimp } from "jimp";
Your website docs is correct but the README on NPM is wrong.
- Lenguaje dominante
- TypeScript
- Estrellas
- 14.7k
- Forks
- 777
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de jimp-dev/jimp
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Add blit changes to migration guide.Posiblemente ocupada @ryanchou1994 la tomó hace 43 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
documentation help wanted solution in issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 62/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
Todos los issues de jimp-dev/jimp
Issues similares
-
Replace discontinued crypto-js in the themePosiblemente ocupada @aelmanaa la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
PaloAltoNetworks/docusaurus-openapi-docs#1689 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
solana-foundation/solana-web3.js#4015 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
formatSearchQuery drops the :present modifier, so `email:present=true` is sent as `email=true`Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 1/5 1-3 horas Aptitud para principiantes 90/100
ivopogace/opencode-courier#422 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
chapel-lang/chapel-vscode#158 ·
Los mantenedores suelen responder en 1 día