From 5dd61fb9a9630a7a4332204ce119b6bc353babd9 Mon Sep 17 00:00:00 2001 From: sshleifer Date: Tue, 11 Feb 2020 14:41:29 -0500 Subject: [PATCH] Add more specific testing advice to Contributing.md --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c313dad9fd..4387cb6d82c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -198,8 +198,11 @@ Follow these steps to start contributing: 3. To indicate a work in progress please prefix the title with `[WIP]`. These are useful to avoid duplicated work, and to differentiate it from PRs ready to be merged; -4. Make sure pre-existing tests still pass; -5. Add high-coverage tests. No quality test, no merge; +4. Make sure existing tests pass; +5. Add high-coverage tests. No quality test, no merge. +If you are adding a new model, make sure that you use `ModelTester.all_model_classes`, which triggers the common tests. +If you are adding new `@slow` tests, make sure they pass using `RUN_SLOW=1 python -m pytest tests/test_my_new_model.py`. +CircleCI does not run them. 6. All public methods must have informative docstrings;