From 593b4b5eec3836747c10edaebc801955e5b8d310 Mon Sep 17 00:00:00 2001 From: Liam Marshall Date: Wed, 4 Nov 2015 21:31:18 -0600 Subject: [PATCH] Add notices about known issues to docs --- docs/contributing.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a3baa7bc5..efc6c27ae 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -280,8 +280,14 @@ Steps: 4. Run ``tox -e lint`` to check for pylint errors. Fix any errors. 5. Run ``tox`` to run the entire test suite including coverage. Fix any errors. 6. If your code touches communication with an ACME server/Boulder, you - should run the integration tests, see `integration`_. + should run the integration tests, see `integration`_. See `Known Issues`_ + for some common failures that have nothing to do with your code. 7. Submit the PR. +8. Did your tests pass on Travis? If they didn't, it might not be your fault! + See `Known Issues`_. If it's not a known issue, fix any errors. + +.. _Known Issues: + https://github.com/letsencrypt/letsencrypt/wiki/Known-issues Updating the documentation ==========================