s_ranjbar/summer_course_2024
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update 'CONTRIBUTING.md'

Browse Source 
Correct the manual
This commit is contained in:
Guille 2020-06-09 08:12:55 -04:00
parent e9ebb5197d
commit fa5245181d
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -8,7 +8,8 @@ Before sending your pull requests, make sure you followed this list.
- Read [Code of Conduct](CODE_OF_CONDUCT.md). - 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). - 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). - 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 ## How to become a contributor and submit your own code
@ -73,8 +74,8 @@ pip install pylint
pylint --rcfile=pylintrc myfile.py pylint --rcfile=pylintrc myfile.py
``` ```
<a name="testing_best_practices"></a>
<a name="testing_best_practices"></a>#### 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. 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 * 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. * Maximize your code coverage by ensure that you are testing as much of your code as possible.
<a name="documentation"></a>#### Documentation <a name="documentation"></a>
#### 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. 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.