We welcome community contributions to the Lightning Pose App repo! If you have found a bug or would like to request a minor change, please open an issue.
In order to contribute code to the repo, please follow the steps below.
We strive to maintain a fun and inclusive environment for our users and contributors. See our code of conduct for more information.
In order to make changes to Pose App, you will need to fork the repo.
If you are not familiar with git, check out this guide.
Whenever you initially install the Pose App repo, instead of
pip install -e .run
pip install -e .[dev]to install additional development tools.
After making changes in your fork, open a pull request from your fork. Please read through the rest of this document before submitting the request.
Linters automatically find (and sometimes fix) formatting issues in the code. We use two, which are run from the command line in the Pose App repo:
flake8: warns of syntax errors, possible bugs, stylistic errors, etc. Please fix these!
flake8 .isort: automatically sorts import statements
isort .We currently do not have unit tests or continuous integration (CI) set up for this repo. For now we will discuss testing of contributions on a case-by-case basis.