zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Soften tone for code review guidelines

Browse Source
This commit is contained in:
yuvipanda
2018-07-31 12:59:24 -07:00
parent b5e6a27fa8
commit c6f2ecfd7f
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/contributing/code-review.rst
View File

@@ -24,7 +24,9 @@ it is a bug.
Do not worry about having perfect documentation! Documentation improves over Do not worry about having perfect documentation! Documentation improves over
time. The requirement is to have documentation before merging a pull request, 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. 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 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 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, feels exhaustively unit-testable, write unit tests too. When in doubt,
add more tests. 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!