litecli/CONTRIBUTING.md

Development Guide

This is a guide for developers who would like to contribute to this project. It is recommended to use Python 3.7 and above for development.

If you're interested in contributing to litecli, thank you. We'd love your help! You'll always get credit for your work.

GitHub Workflow

1. Fork the repository on GitHub.

2. Clone your fork locally:

   $ git clone <url-for-your-fork>
   

3. Add the official repository (upstream) as a remote repository:

   $ git remote add upstream git@github.com:dbcli/litecli.git
   

4. Set up a virtual environment for development:

   $ cd litecli
   $ pip install virtualenv
   $ virtualenv litecli_dev
   

   We've just created a virtual environment that we'll use to install all the dependencies and tools we need to work on litecli. Whenever you want to work on litecli, you need to activate the virtual environment:

   $ source litecli_dev/bin/activate
   

   When you're done working, you can deactivate the virtual environment:

   $ deactivate
   

5. Install the dependencies and development tools:

   $ pip install -r requirements-dev.txt
   $ pip install --editable .
   

6. Create a branch for your bugfix or feature based off the main branch:

   $ git checkout -b <name-of-bugfix-or-feature>
   

7. While you work on your bugfix or feature, be sure to pull the latest changes from upstream. This ensures that your local codebase is up-to-date:

   $ git pull upstream main
   

8. When your work is ready for the litecli team to review it, push your branch to your fork:

   $ git push origin <name-of-bugfix-or-feature>
   

9. Create a pull request on GitHub.

Running the Tests

While you work on litecli, it's important to run the tests to make sure your code hasn't broken any existing functionality. To run the tests, just type in:

$ ./setup.py test

litecli supports Python 3.7+. You can test against multiple versions of Python by running tox:

$ tox

CLI Tests

Some CLI tests expect the program ex to be a symbolic link to vim.

In some systems (e.g. Arch Linux) ex is a symbolic link to vi, which will change the output and therefore make some tests fail.

You can check this by running:

$ readlink -f $(which ex)

Coding Style

litecli uses black to format the source code. Make sure to install black.

It's easy to check the style of your code, just run:

$ ./setup.py lint

If you see any style issues, you can automatically fix them by running:

$ ./setup.py lint --fix

Be sure to commit and push any stylistic fixes.