LuaLS / LuaLS/lua-language-server

Document how to setup dev environment

Abierto
#3,108 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation
Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Issue Description

Quoting @carsakiller from https://github.com/LuaLS/LuaLS.github.io/pull/35#issuecomment-2134278430:

@sumneko would you be able to provide some more insight into how you develop the language server? I think I recall you saying that development is primarily test-driven. However, I'm not sure how the testing framework works — I believe it is custom? Some pointers on writing and running tests would be appreciated!

Is there a specific flow/method you would recommend for contributors? For the few simple things I have contributed, I have just used print() as described in this PR — but I don't think it would be very efficient for larger changes.

I think creating good documentation here for developing the language server would greatly help the community make some really nice pull requests. I've seen many comments from users eager to help but confused when getting their development environment set up and navigating the codebase.

Some initial work was recently merged in https://github.com/LuaLS/LuaLS.github.io/pull/35.

Additional Notes

No response

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

Revisa las instrucciones de desarrollo añadidas en LuaLS.github.io pull request 35 y la discusión enlazada para obtener el contexto solicitado. Documenta la configuración del entorno, el framework de pruebas y cómo escribir y ejecutar pruebas, además de un flujo de trabajo recomendado para los colaboradores; se considera terminado cuando una persona nueva puede seguir la guía sin depender de la depuración con print().

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

Evaluación

Stack tecnológico
lua
Área
developer-experience, documentation, testing-qa
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.