From c6f2ecfd7fae85ca9fedcae9b450cd0735295c5f Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Tue, 31 Jul 2018 12:59:24 -0700 Subject: [PATCH] Soften tone for code review guidelines --- docs/contributing/code-review.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/contributing/code-review.rst b/docs/contributing/code-review.rst index 7c56ca2..1c2f406 100644 --- a/docs/contributing/code-review.rst +++ b/docs/contributing/code-review.rst @@ -24,7 +24,9 @@ it is a bug. Do not worry about having perfect documentation! Documentation improves over time. The requirement is to have documentation before merging a pull request, -not to have *perfect* documentation before merging a pull request. +not to have *perfect* documentation before merging a pull request. If you +are new and not sure how to add documentation, other contributors will +be happy to guide you. See :ref:`contributing/docs` for guidelines on writing documentation. @@ -41,4 +43,7 @@ Since TLJH is a distribution that integrates many JupyterHub components, integration tests provide more value for effort than unit tests do. Unit tests are easier to write & faster to run, so if the code being changed feels exhaustively unit-testable, write unit tests too. When in doubt, -add more tests. \ No newline at end of file +add more tests. + +If you are unsure what kind of tests to add for your pull request, other +contributors to the repo will be happy to help guide you! \ No newline at end of file