Permalink
Browse files

Update PULL_REQUEST_TEMPLATE.md (#9003)

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md
  • Loading branch information...
1 parent d77d937 commit 918fac3d07450e788bb2c214482da053e11cc065 @eric-haibin-lin eric-haibin-lin committed with piiswrong Dec 9, 2017
Showing with 9 additions and 3 deletions.
  1. +9 −3 .github/PULL_REQUEST_TEMPLATE.md
@@ -5,9 +5,15 @@
### Essentials ###
- [ ] Passed code style checking (`make lint`)
- [ ] Changes are complete (i.e. I finished coding on this PR)
-- [ ] All changes have test coverage
-- [ ] For user-facing API changes, API doc string has been updated. For new C++ functions in header files, their functionalities and arguments are well-documented.
-- [ ] To my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
+- [ ] All changes have test coverage:
+- Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
+- Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
+- Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
+- [ ] Code is well-documented:
+- For user-facing API changes, API doc string has been updated.
+- For new C++ functions in header files, their functionalities and arguments are documented.
+- For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
+- [ ] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
### Changes ###
- [ ] Feature1, tests, (and when applicable, API doc)

0 comments on commit 918fac3

Please sign in to comment.