Update CONTRIBUTING.md

CONTRIBUTING.md

@@ -1 +1,56 @@
+# 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
+
+- Add a theme
+- Report a bug ( [see GitHub issue tracker](https://github.com/kraanzu/termtyper/issues) )
+- Suggest a new feature or enhancement ( [see GitHub issue tracker](https://github.com/kraanzu/termtyper/issues) )
+- Open a PR for any of the reasons above
+
+<hr>
+
+
+## Adding a theme
+
+Currently, we're using [themes from monkeytype](https://github.com/monkeytypegame/monkeytype/tree/master/frontend/static/themes) 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](smassh/ui/css/themes) \
+
+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](#setting-up-local-environment) )
+- make sure everything looks as expected
+
+## Setting up Local environment
+
+> [!NOTE]
+> We are using [poetry](https://python-poetry.org/) 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 setup pre-commit hooks for GitHub which will automatically run `ruff` and `black` to test your code
+
+- Finally you can run the app
+  ```bash
+  smassh
+  ```
+
+- If you see a typing screen that means everything is installed properly
+
+