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

Update 'CONTRIBUTING.md'

Browse Source 
add anchors
This commit is contained in:
Guille 2020-06-09 08:14:22 -04:00
parent fa5245181d
commit a91a8733f1
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -9,7 +9,7 @@ Before sending your pull requests, make sure you followed this list.
- 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).
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices). - Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices).
- [Document your work](CONTRIBUTING.md#documentation). - [Document your work](CONTRIBUTING.md#markdown-header-documentation).
## How to become a contributor and submit your own code ## How to become a contributor and submit your own code
@ -83,7 +83,6 @@ 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 #### 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.