Extend note about contributing to the C++ frontend (#15902)
authorPeter Goldsborough <psag@fb.com>
Thu, 10 Jan 2019 22:05:21 +0000 (14:05 -0800)
committerFacebook Github Bot <facebook-github-bot@users.noreply.github.com>
Thu, 10 Jan 2019 22:22:00 +0000 (14:22 -0800)
Summary:
soumith ezyang
Pull Request resolved: https://github.com/pytorch/pytorch/pull/15902

Differential Revision: D13628525

Pulled By: goldsborough

fbshipit-source-id: 70cf36d1bacd9d689d4fa4f2290886fd3765e89b

docs/cpp/source/contributing.rst

index 14ae922..cfe81f0 100644 (file)
@@ -4,5 +4,16 @@ Contributing to PyTorch
 If you would like to contribute to the PyTorch C++ API, refer to the
 `CONTRIBUTING.md
 <https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md>`_ document in
-the PyTorch repository.  It contains instructions on how to develop PyTorch from source
-and submit a proposal for your patch or feature. We will be happy to review it!
+the PyTorch repository. It contains instructions on how to develop PyTorch from source
+and submit a proposal for your patch or feature.
+
+Specifically for the C++ frontend, just a note about tests: We have very
+extensive tests in the `test/cpp/api
+<https://github.com/pytorch/pytorch/blob/master/test/cpp/api/>`_ folder. The
+tests are a great way to see how certain components are intended to be used.
+Wh∑en compiling PyTorch from source, the test runner binary will be written to
+``build/bin/test_api``. The tests use the `GoogleTest
+<https://github.com/google/googletest/blob/master/googletest/>`_ framework,
+which you can read up about to learn how to configure the test runner. When
+submitting a new feature, we care very much that you write appropriate tests.
+Please follow the lead of the other tests to see how to write a new test case.