Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.12 KB
Raw

Contributing to Smassh! ⌨️

Thanks for taking the time to contribute to smash

What can I contribute?

You can do that in a lot of ways

Adding a theme

Currently, we're using themes from monkeytype but if you feel like some theme is missing, feel free to open a PR to add it! \

The theme format is pretty simple and you can look into any of the theme files

Steps:

  • Create a new theme file with .tcss extension
  • Place it inside dir smassh/ui/css/themes (smassh will automatically detect the new theme)
  • Run the app (see setup) and select the theme ( see setup )
  • make sure everything looks as expected

Setting up Local environment

Note

We are using poetry but you can use any alternative if you want

Steps:

  • Fork and Clone the repo to your local machine

  • run poetry shell
    This should create an isolated virtual environment for you

  • run poetry install
    This will install all the required and dev dependencies

  • run pre-commit install
    This will set pre-commit hooks for GitHub which will automatically run ruff and black to test your code

  • Finally, you can run the app

    smassh

  • If you see a typing screen that means everything is installed properly

Before opening a PR

Before you open your PR, please go through this checklist and make sure you've checked all the items that apply:

  • Update the CHANGELOG.md
  • Format your code with black
  • All your code has docstrings in the style of the rest of the codebase

Questions

If you have any questions, comments, concerns, or problems let me know on Discord or ask a question on Smassh's GitHub discussions and I'll be happy to assist you.