From 9f7e3a35c03b10f793eefd9e020fe278cf2bcb3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20W=C4=85troba?= Date: Sat, 19 Dec 2020 08:33:45 +0100 Subject: [PATCH] Add how to contribute --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e11b1a6..e405385 100644 --- a/README.md +++ b/README.md @@ -87,8 +87,8 @@ st.GetUsersRunner( users = users_collector.get_scrapped_users() ``` -Stweet has a default `WebClient` implementation that is based on `requests` library — `st.RequestsWebClient`. -Class have all properties with default values, but by changing them user can set proxy or disable ssl verification. +Stweet has a default `WebClient` implementation that is based on `requests` library — `st.RequestsWebClient`. Class have +all properties with default values, but by changing them user can set proxy or disable ssl verification. This snippet shows how to use it: @@ -235,6 +235,21 @@ options that can be used in [requests.request](https://requests.readthedocs.io/e Additionally, you can implement you own WebClient. +## How to contribute + +If you want to improve stweet library then please read the instruction +in [first-contributions repo](https://github.com/firstcontributions/first-contributions). Remember to create pull +request to `develop` branch. + +You must have `docker` and `docker-compose` to run all tests on your computer. These dependencies start the proxy +service which is required to run proxy tests. If you want to run tests locally please run `tox` command: + +```bash +tox -v +``` + +Thank you for your every pull request. Together we can make this library better. + ## Twint inspiration Small part of library uses code from [twint](https://github.com/twintproject/twint). Twint was also main inspiration to