LuaLS / LuaLS/lua-language-server

Document how to setup dev environment

Ouverte
#3,108 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation
Langage dominant
Lua
Étoiles
4.4k
Forks
442
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez les consignes de développement ajoutées dans LuaLS.github.io pull request 35 ainsi que la discussion liée pour obtenir le contexte demandé. Documentez la configuration de l’environnement, le framework de test et la manière d’écrire et d’exécuter des tests, ainsi qu’un workflow recommandé pour les contributeurs ; le travail est considéré comme terminé lorsqu’un nouveau contributeur peut suivre le guide sans dépendre du débogage avec print().

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
developer-experience, documentation, testing-qa
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.