CONTRIBUTING.md

How to contribute

• How to contribute
  • Develop installation
  • Code style
  • Git commit message
  • Developing with Poetry

Since lark-shell is still in beta, you can contribute by:

• Making the UI better
• Add features (so it can surpass the online IDE)
• Cross platform support (a.k.a. stop relying on the wonderful urwid library)
• Adding a test suite (and code coverage)

Develop installation

Since this project uses poetry to manage the dependencies, you would have to install it first:

For *nix/MacOS users:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

For Windows PowerShell users:

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -

...git clone the repo:

$ git clone https://github.com/ThatXliner/lark-shell.git

and run poetry lock:

$ poetry lock

What does this do?

Code style

See here

Git commit message

Use the GitMoji convention.

Developing with Poetry

When you do poetry lock, it will generate a virtual environment in your project. If it says it can't due to the installed python versions won't be compatible with the required python versions (currently 3.6+), do not freak out. Do not get yourself into some Homebrew mess. Install PyEnv (without Homebrew) and be happy.

poetry lock will also generate (or update) the poetry.lock file. This is used for helping with deterministic installation (preventing situations like "well, it worked on my machine").

While there is no poetry test command, lark-shell currently does not have a test suite (contribute!).

All changes are welcome 😄