Skip to content

Contributing

Contributers Welcome!

Contribution from the any and all is welcomed and appreciated! Check out the issues on github. If you have an idea for an enhancement, or notice something not working properly, please do open a new issue and open a pull request if you want to lend a hand!

Environment setup

Here's how to set up your development environment:

  1. Clone the repository in your development environment.
  2. Install poetry if it is not already installed on your system.
  3. Run the poetry install command to install the project dependencies.
  4. At the root of the repo run poetry run python path/to/commands.py init. This will create a file called sql-unit-test.yaml at the root, among other things. Change the app_env value to be 'dev'.
  5. To adjust the log level, modify the log_level value in sql-unit-test.yaml. (Options are CRITICAL/WARN/ERROR/INFO/DEBUG; default is WARN)
  6. Get developing!
  7. To test run the package use poetry: poetry run python path/to/commands.py run in /sample/playlists or in a unit test directory you create.

Testing

It is requested that contributers write new unit tests for any new or modified functionality in the codebase. Please put these in the /tests folder.

Feel free to run your tests locally, but the tests will also be executed by github upon the opening of your pull request.