Hi! We're really excited that you're interested in contributing to Shotit! Before submitting your contribution, please read through the following guide.
To contribute to this project, please follow a "fork and pull request" workflow.
Please do not try to push directly to Shotit repositories unless you are a maintainer.
To develop locally, fork the shotit repository and clone it in your local machine. The shotit repo acts like a monorepo using git modules. The programming language of shotit is mainly javascript, except for shotit-sorter(Python).
| Shotit Repository | Coverage | Language | Package Manager |
|---|---|---|---|
| shotit | - | - | - |
| shotit-api |  |
JavaScript | yarn |
| shotit-media |  |
JavaScript | yarn |
| shotit-worker | TBD | JavaScript | yarn |
| shotit-sorter |  |
Python | pip |
To debug and test, you may refer to the README and package.json files of the responsive repository for more information.
No matter how small, we appreciate every contribution. You're awesome!