If you want to talk about a contribution before you start writing code & making a pull request, please file an issue. You can also find me (cyberwiz) semi-regularly on the official locust slack.
In order to maintain a good level of quality, please ensure that your code:
-
Is formatted using black (https://github.com/psf/black)
-
Passes linting with pylint (https://www.pylint.org/)
-
Has relevant examples here
This project has a dev container definition - https://code.visualstudio.com/docs/remote/containers#
If you have Docker and visual studio code installed all you need to do is open the repository in vs code and select "re-open in container" in the popup that appears in the bottom right. Dependencies and plugins will be automatically handled.
The development image has some quality of life scripts baked into it
-
running
tusk formatWill run the black formatter on examples/ and locust_plugins/ -
tusk pylintwill run pylint against on examples/ and locust_plugins/ -
tusk testwill run the tox test suite in the 3.9 environment