This is an automated email from the ASF dual-hosted git repository.
jxie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new dea19e3 Add recommendation to use RAII to the contributors guide
(#9439)
dea19e3 is described below
commit dea19e3d81677655c54c4a2eae485c420226b721
Author: Pedro Larroy <[email protected]>
AuthorDate: Mon Jan 15 20:39:38 2018 +0100
Add recommendation to use RAII to the contributors guide (#9439)
---
docs/community/contribute.md | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/docs/community/contribute.md b/docs/community/contribute.md
index 7a38295..5bb790e 100644
--- a/docs/community/contribute.md
+++ b/docs/community/contribute.md
@@ -10,7 +10,12 @@ After your patch has been merged, remember to add your name
to [CONTRIBUTORS.md]
- Follow the [Google C++ Style
Guide](https://google.github.io/styleguide/cppguide.html) for C++ code.
- Use doxygen to document all of the interface code.
-- To reproduce the linter checks, type ```make lint```.
+- Use [RAII](http://en.cppreference.com/w/cpp/language/raii) to manage
resources, including smart
+ pointers like shared_ptr and unique_ptr as well as allocating in constructors
and deallocating in
+ destructors. Avoid explicit calls to new and delete when possible. Use
make_shared and make_unique
+ instead.
+- To reproduce the linter checks, type ```make lint```. (You need to pip
install pylint and cpplint
+ before)
### Python Package
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
