Add contributing guide to setup dev environment #470
Conversation
|
@ccordoba12 Could you advise what info would be important to have in a contributing guide? |
Co-authored-by: Pavel Kulyov <[email protected]>
staticf0x
force-pushed
the
contributing-guide
branch
from
7848ee7 to
b9cbb89
Compare
There was a problem hiding this comment.
Thanks for your contribution @staticf0x! I left a discussion comment for you below.
CONTRIBUTING.md
Outdated
|
|
||
| ## Configure your editor | ||
|
|
||
| In Sublime Text 4, open LSP-pylsp settings and change the path to the `pylsp` command: |
There was a problem hiding this comment.
I don't know if mentioning one preferred editor over others is a good idea because the setup and development workflow is completely different for each of them. I mean, I could write a guide for Spyder as well (which would be useful for our interested contributors) and it'd be another thing entirely.
So, perhaps having a contributing guide per editor would be better?
There was a problem hiding this comment.
I understand, I initially mentioned ST4 because making it use a custom pylsp path was very difficult, so I felt it was important. But yes, there's too many editors and IDEs to cover that it might not be a good idea to have it in the contributing guide.
So, perhaps having a contributing guide per editor would be better?
That sounds like a good idea.
There was a problem hiding this comment.
So, perhaps having a contributing guide per editor would be better?
That sounds like a good idea.
Or perhaps none at all? Surely, those who are able and willing to contribute will be able to configure their editor already.
There was a problem hiding this comment.
Removed the ST config in favor of a generic point of configuring the editor.
There was a problem hiding this comment.
Last suggestions for you @staticf0x, then this should be ready.
ccordoba12
changed the title
Co-authored-by: Carlos Cordoba <[email protected]>
|
Done, thanks |
This was prompted by #216 and I wanted to document how to get started first, because for me at least it was the biggest obstacle (not necessarily because of python-lsp-server itself, but the cooperation with sublime text too). However, I quickly got into troubles as I didn't know what kind of information this guide could and should contain. Not sure if I'll be able to create something good enough without deeper knowledge of pylsp.