Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.33 KB

How to contribute to this project

If you are interested in contributing to the development and maintenance of this package, it is recommended that you use poetry for dependency management and pyenv for python version management.

Environment

Clone the project

git clone https://github.com/dynovaio/lark-parser-language-server.git
cd lark-parser-language-server

Install the rquited python versions

pyenv install $(cat .python-version)

Install the dependencies

poetry env use $(head -n 1 .python-version)
poetry install

Testing and coverage

You can run the tests with poetry

poetry run pytest \
    --cov lark_parser_language_server \
    --cov-report xml:cobertura.xml \
    --cov-report term  \
    --junitxml report.xml
poetry run coverage report

In case you want to run the tests in all versions you can use tox

Do you want to send a PR?

Before making your first commit and submitting your pull request, run

poetry run pre-commit install

Then do your commits on a regular basis.

Code of Conduct

Please note that this project is published with a Code of Conduct for collaborators. By participating in this project, you agree to abide by its terms.