From fa5245181d30601b1c45f8ea9955f27264f29dc4 Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 08:12:55 -0400 Subject: [PATCH] Update 'CONTRIBUTING.md' Correct the manual --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dafb5fb5..8050db0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,8 @@ Before sending your pull requests, make sure you followed this list. - Read [Code of Conduct](CODE_OF_CONDUCT.md). - Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution). - Changes are consistent with the [Coding Style](CONTRIBUTING.md#coding-style). -- Run [Unit Tests](CONTRIBUTING.md#running-unit-tests). +- Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices). +- [Document your work](CONTRIBUTING.md#documentation). ## How to become a contributor and submit your own code @@ -73,8 +74,8 @@ pip install pylint pylint --rcfile=pylintrc myfile.py ``` - -#### Testing best practices + +#### Testing best practices Prior to any pull request is expected that the code is both, manualy and automatically tested, to ensure at least some quality minimum, there are a few practices for unittest that we believe are important, so we encorage you to follow it. @@ -82,6 +83,7 @@ Prior to any pull request is expected that the code is both, manualy and automat * We encorage you to create if possible functional tests that cover the complete workflow of the implemented functionality * Maximize your code coverage by ensure that you are testing as much of your code as possible. -#### Documentation + +#### Documentation In case of new functionality a general overview, configuration, instalation and usage manuals need to be provided by the developer, this will not only provide a nice starting point for all the future users but help you to detect any inconsistences in your design.