Update CONTRIBUTING.md

CrowdStrike · jshcodes · Mar 25, 2021 · Mar 25, 2021 · Mar 25, 2021 · Mar 25, 2021
commit f8927f9fa5680641fc0685ecde7252849e07f542
@@ -50,9 +50,54 @@ If this is a concern, contact the maintainers before contributing.
     - For scenarios where unit testing passes in the PR and fails post-merge, a maintainer will address the issue. If the problem is programmatic and related to code within the pull request, the merge may be reverted.
 + The util folder contains BASH scripts for triggering unit tests that match unit testing performed as part of our GitHub workflows.
 
+#### Posting coverage results to Pull Requests
+Our Pull Request template provides an area for you to post the coverage results from your local unit tests. This table is generated by the command `coverage report` and is executed when you use the "run-tests.sh" BASH script found in the util folder. This table is output only when all unit tests have passed successfully, and is a required element for Pull Request approval.
+
+##### Example coverage results
+```shell
+Name                                        Stmts   Miss  Cover
+---------------------------------------------------------------
+src/falconpy/__init__.py                       10      0   100%
+src/falconpy/_endpoint.py                       1      0   100%
+src/falconpy/_result.py                         8      0   100%
+src/falconpy/_service_class.py                 31      0   100%
+src/falconpy/_util.py                          80      0   100%
+src/falconpy/_version.py                        8      0   100%
+src/falconpy/api_complete.py                   77      0   100%
+src/falconpy/cloud_connect_aws.py              66      0   100%
+src/falconpy/cspm_registration.py             114      0   100%
+src/falconpy/detects.py                        34      0   100%
+src/falconpy/device_control_policies.py        67      0   100%
+src/falconpy/event_streams.py                  15      0   100%
+src/falconpy/falconx_sandbox.py                78      0   100%
+src/falconpy/firewall_management.py           130      0   100%
+src/falconpy/firewall_policies.py              68      0   100%
+src/falconpy/host_group.py                     61      0   100%
+src/falconpy/hosts.py                          37      0   100%
+src/falconpy/incidents.py                      39      0   100%
+src/falconpy/intel.py                          89      0   100%
+src/falconpy/iocs.py                           58      0   100%
+src/falconpy/oauth2.py                         30      0   100%
+src/falconpy/prevention_policy.py              67      0   100%
+src/falconpy/real_time_response.py            135      0   100%
+src/falconpy/real_time_response_admin.py       82      0   100%
+src/falconpy/sensor_update_policy.py          103      0   100%
+src/falconpy/spotlight_vulnerabilities.py      15      0   100%
+src/falconpy/user_management.py                75      0   100%
+---------------------------------------------------------------
+TOTAL                                        1578      0   100%
+```
+
+#### More details regarding PyTest and Coverage
+For more information regarding PyTest, and how we leverage it to perform unit testing, refer to the [PyTest documentation](https://docs.pytest.org/en/stable/contents.html#toc).
+
+To find out more above Coverage, review their [website](https://coverage.readthedocs.io/en/coverage-5.5/).
+
 ### Linting
 All submitted code must meet minimum linting requirements. We use `flake8` for linting. Refer to the "lint.sh" script within the util folder to review our standard linting parameters.
 
+More information about flake8 can be found [here](https://flake8.pycqa.org/en/latest/).
+
 ### Branch targeting
 _Please do not target the `main` branch with your Pull Request unless directed to do so by a maintainer_. Instead, target your PR at the most recent development branch.