Skip to content

Commit 3247a30

Browse files
committed
Add initial contributor guidelines
1 parent bb46964 commit 3247a30

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributor guidelines
2+
3+
## Before you start
4+
5+
LSP is a universal language server package.
6+
It is not the place for language-specific logic, features or workarounds.
7+
8+
Sublime Text is not an IDE.
9+
Sublime Text users may appreciate IDE-like features, but a significant number of users will want to turn these features off due to performance or to keep the package "out of the way".
10+
11+
Please feel free to create an issue before coding:
12+
13+
* If you are unsure your proposal is suitable
14+
* If you are unsure your solution will be technically sound
15+
16+
The issues also allow you to gather some feedback and help from other contributors.
17+
18+
## Coding
19+
20+
Sublime Text 3 bundles a Python 3.3, please be sure to set up your environment to match.
21+
LSP uses two flake8 and mypy to provide some code quality assurances.
22+
I highly recommend enabling plugins for these in your Python coding environment.
23+
If you have these tools available on your machine, you can check your work with:
24+
25+
```
26+
flake8 main.py
27+
mypy main.py
28+
```
29+
30+
## Testing
31+
32+
Please consider testing your work with other language servers, even if you do not use them.
33+
The Javascript/Typescript language server is a good example, it has a fairly complete feature set.
34+
35+
## Submitting
36+
37+
Before you submit your pull request, please review the following:
38+
39+
* Any unrelated changes in there?
40+
* Is it a bug fix? Please link the issue or attach repro, logs, screenshots etc.
41+
* Is it a feature? Please attach screenshots / GIFs for visual changes.
42+
43+
I will try to help you get the PR in mergeable shape within a reasonable time, but it may take a few days.
44+
It is best if you check your Github notifications in the meantime!

0 commit comments

Comments
 (0)