thisisnic commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r763771394
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
+
+Adding a new unit tests is needed when adding a new feature,
+a binding or a bug fix.
+
+It can also happen your work will involve adding a unit test
+to a code already written, modifying a unit test or even making
+more than one unit test for the changes in the code.
+
+It is also possible to make changes that do not require adding
+a unit test like :ref:`documentation`.
+
+If you do need to work with unit tests, this section will help
+you with the necessary steps.
Review comment:
Happy for you to push back on this if you disagree, but perhaps we don't
need these paragraphs? I'd be tempted to cut all of this out, and just go with
something along the lines of "In this section we outline steps needed for unit
testing in Arrow".
I think we can probably assume that anyone who is thinking of contributing
to Arrow already knows typical software development process steps (including
unit testing), and it's only how to do it on this project which is new
knowledge to them. It's a huge task to educate people on what to test or not,
and I'm not sure we want to take it up! :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
