From c4186cd0bc8218ce7c2957c2cd33f4200612f948 Mon Sep 17 00:00:00 2001 From: d33bs Date: Sat, 12 Oct 2024 06:43:55 -0600 Subject: [PATCH 1/2] add information about code coverage to docs --- doc/source/development/contributing_codebase.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index 670ffe6996302..ffc6d112213aa 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -298,6 +298,12 @@ So, before actually writing any code, you should write your tests. Often the te taken from the original GitHub issue. However, it is always worth considering additional use cases and writing corresponding tests. +We use `code coverage `_ to help understand +the amount of code which is covered by a test. We recommend striving to ensure code +you add or change within Pandas is covered by a test. Please see our +`code coverage dashboard through Codecov `_ +for more information. + Adding tests is one of the most common requests after code is pushed to pandas. Therefore, it is worth getting in the habit of writing tests ahead of time so this is never an issue. From 700f2512e6c94eabd70aaa86d8cb86f37eaf1eec Mon Sep 17 00:00:00 2001 From: d33bs Date: Sun, 13 Oct 2024 13:59:45 -0600 Subject: [PATCH 2/2] linting --- doc/source/development/contributing_codebase.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index ffc6d112213aa..c1cfb0d7a623b 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -300,7 +300,7 @@ use cases and writing corresponding tests. We use `code coverage `_ to help understand the amount of code which is covered by a test. We recommend striving to ensure code -you add or change within Pandas is covered by a test. Please see our +you add or change within Pandas is covered by a test. Please see our `code coverage dashboard through Codecov `_ for more information.