Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

41 lines (24 loc) · 1.07 KB

Contributing

First, thank you! It is thanks to people like you that open source is great.

There are more than one way to contribute to this project; namely, coding and writing feedbacks/suggestions.

Follow the steps below to get started.

Coding

Clone the master branch:

$ git clone https://github.com/InSyncWithFoo/pyright-for-pycharm -b master

Then, make your changes. Run the "Run Plugin" run configuration to start PyCharm in a sandbox with the plugin installed. It may take a while for the first time.

Note that all tests must not fail. Existing tests should be modified to reflect the changes if necessary. Open a PR once you are sure that your modifications work correctly.

Priority

New features, bug fixes, and improvements are always welcome. However, good tests are most appreciated.

Feedback

You can also help by installing unreleased versions (which are automatically generated as Actions artifacts) and report bugs as you come across them.