rytilahti / python-miio

72%

master: 74%

LAST BUILD ON BRANCH revisit_contributing

branch: revisit_contributing

CHANGE BRANCH

x

Reset

• revisit_contributing
• 0.3.0
• 0.3.1
• 0.3.2
• 0.3.3
• 0.3.4
• 0.3.5
• 0.3.6
• 0.3.7
• 0.3.8
• 0.3.9
• 0.4.0
• 0.4.1
• 0.4.2
• 0.4.3
• 0.4.4
• 0.4.5
• 0.4.6
• 0.4.7
• 0.4.8
• 0.5.0
• 0.5.0.1
• 0.5.1
• 0.5.2
• 0.5.2.1
• 0.5.3
• add-license-1
• add_miottemplate
• add_missing_docu
• add_readthedocs_config
• add_timezone_config
• add_unittest_base
• add_unpause
• add_updater
• add_viomi_v8
• airpurifiermiot/fix/wrong_property_command
• allow_discovery_without_ip_token
• androidbackup_runtime_dep
• apidocs_update
• appdirs_for_cachefile
• aqaracam
• azure-pipelines
• be_less_noisy_on_retries
• blackify
• bump_python_req
• change_volume
• cleanup_property_getting
• common_cli_improvements
• doc/apidoc_build
• doc/improve_doc_presentation
• doc/separate_modules
• drop_pretty_cron
• drop_py34_support
• enumize
• errors_to_exceptions
• extend_yeelight
• extend_yeelight_support
• extract_android_backups
• fanspeed_reporting
• feat/add_version_flag
• feat/labeler
• feat/separete_info_exception
• feat/vacuum/waterflow
• feat/viomi/mopping_mode
• feature/viomi/add_mop_state
• fix-serial-number
• fix/bump_cryptography_dep
• fix/is_on_for_segment_cleaning
• fix/raw_id_to_device
• fix/readthedocs_build
• fix/vacuum/fix_waterbox_enum
• fix/viomi/rename_mop_mode
• fix/viomi_bintype
• fix/viomi_cli
• fix/xiaowa_timezone
• fix_click7_resultcallback
• fix_empty_cleaning_history
• fix_flake8
• fix_gateway_ctor
• fix_last_clean_details
• fix_protocol
• force_empty_params
• gateway
• generalize_config_router
• improve_checks
• improve_chuangmi
• improve_handshaking
• initial_vacuum_tests
• janitor/cleanup_dependency_pins
• master
• miot_basics
• new/chuangmi_hmi208
• poetry_convert
• powerstrip_fixes
• prepare_050
• prepare_0501
• prepare_052
• prepare_0521
• proper_coverage
• proper_info_warning
• refactor/enumtype_default_incasesensitive
• refactor/silent_discovery_retries
• refactor_clean_details
• release/0.5.3
• release_032
• release_033
• release_034
• release_042
• release_044
• release_051
• remove_labeler
• rename-package
• replace_stop_with_pause
• revise_broadcast_discovery
• rytilahti-patch-1
• send_add_extra_params
• sound_commands
• update_docs
• use_upstream_android_backup
• util_refactor
• vacuum/fix/fanspeed_detection
• vacuum_carpet_mode
• vacuum_fix_got_error
• vacuum_gen2
• vacuum_m1s
• vacuum_map_improv
• vacuum_proper_wrap_dndstatus
• vacuum_timeouts
• version_031
• viomi
• viomi_extend
• wifispeaker
• yeelight_bedside_fixes
• yeelight_token_extract
• zimi_clock

Build # 1381

Build Type

Pull #568

travis-ci

Committed by web-flow

Commit Message

Improve the contribution process with better checks and docs

After watching the pycon presentation by @hynek about maintainership[1], I had an urge to go and do something, namely:

* Drop the links from README.rst to make rst-lint pass (not that they were that useful to begin with..), add the black badge
* Add doc8 to pre-commit hooks to enforce that docs do not get broken
* Improve the documentation on how to setup the development environment for potential contributors
* Remove typing from tox.ini until the code follows the standard
* Add lint environment for tox to allow easy execution of all the checks

[1] https://www.youtube.com/watch?v=9G2s1TN9QQY

Pull Request Pull Request #568: Improve the contribution process with better checks and docs

Run Details

474 of 852 branches covered (55.63%)

Branch coverage included in aggregate %.

3169 of 4208 relevant lines covered (75.31%)

1.51 hits per line