Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to setup dev environment #3108

Open
C3pa opened this issue Mar 6, 2025 · 0 comments
Open

Document how to setup dev environment #3108

C3pa opened this issue Mar 6, 2025 · 0 comments
Labels
documentation Has to do with documentation either in the wiki or in the repo

Comments

@C3pa
Copy link
Contributor

C3pa commented Mar 6, 2025

Issue Description

Quoting @carsakiller from LuaLS/LuaLS.github.io#35 (comment):

@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 LuaLS/LuaLS.github.io#35.

Additional Notes

No response

@C3pa C3pa added the documentation Has to do with documentation either in the wiki or in the repo label Mar 6, 2025
@carsakiller carsakiller removed their assignment Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Has to do with documentation either in the wiki or in the repo
Projects
None yet
Development

No branches or pull requests

2 participants