You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2020/08/24 01:17:48 UTC
[GitHub] [incubator-mxnet] szha opened a new pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
szha opened a new pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992
## Description ##
remove mentions of JIRA, update community docs
## Checklist ##
### Essentials ###
Please feel free to remove inapplicable items for your PR.
- [x] Changes are complete (i.e. I finished coding on this PR)
- [x] Code is well-documented
### Changes ###
- [x] remove mentions of JIRA
- [x] update community docs (credit: many are adapted from tvm)
- [x] update github template
- [x] create RFC issue template
## Comments ##
- https://lists.apache.org/thread.html/rc2b2615fd9b43d90f35b584621e1f57c08e221061ffdef60c15c14cb%40%3Cdev.mxnet.apache.org%3E
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-678856348
Hey @szha , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:
- To trigger all jobs: @mxnet-bot run ci [all]
- To trigger specific jobs: @mxnet-bot run ci [job1, job2]
***
**CI supported jobs**: [clang, centos-cpu, windows-gpu, centos-gpu, windows-cpu, unix-gpu, website, edge, miscellaneous, sanity, unix-cpu]
***
_Note_:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 edited a comment on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 edited a comment on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-679310318
Sorry I wasn't accurate about the clipboard trigger, wrapping code inside either ` ```bash ` or `{% highlight bash %}` works the same. But in the new docs, ` ``` {.bash} ` was used which won't trigger the clipboard.
I suggest reverting the last commit, and only update the new docs to use either ` ```bash ` or `{% highlight bash %}`, and not touching the rest of tutorials and api markdowns as the clipboard works on those pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
szha commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-680296589
@mxnet-bot run ci [unix-cpu, windows-gpu]
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 commented on a change in pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 commented on a change in pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#discussion_r475333569
##########
File path: docs/python_docs/themes/mx-theme/mxtheme/footer.html
##########
@@ -4,13 +4,12 @@
<div class="col-4">
<h4 class="footer-category-title">Resources</h4>
<ul class="contact-list">
- <li><a class="u-email" href="mailto:dev@mxnet.apache.org">Dev list</a></li>
- <li><a class="u-email" href="mailto:user@mxnet.apache.org">User mailing list</a></li>
- <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li>
- <li><a href="https://issues.apache.org/jira/projects/MXNET/issues">Jira Tracker</a></li>
- <li><a href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Github Roadmap</a></li>
+ <li><a href="https://lists.apache.org/list.html?dev@mxnet.apache.org">Dev list</a> (<a class="u-email" href="mailto:dev-subscribe@mxnet.apache.org">subscribe</a>)</li>
Review comment:
This footer link here is different from main site.
And the parentheses appear black while "subscribe" text is white. We can put parentheses inside the inner `<a/>` tag like this `<a class="u-email" href="mailto:dev-subscribe@mxnet.apache.org">(subscribe)</a>`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 edited a comment on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 edited a comment on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-679310318
Sorry I wasn't accurate about the clipboard trigger, wrapping code inside either ` ```bash ` or `{% highlight bash %}` works the same. But in the new contributes docs, ` ``` {.bash} ` was used which won't trigger the clipboard.
I suggest reverting the last commit, and only update the new docs to use either ` ```bash ` or `{% highlight bash %}`, and not touching the rest of tutorials and api markdowns as the clipboard works on those pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 commented on a change in pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 commented on a change in pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#discussion_r475335574
##########
File path: docs/static_site/src/pages/community/code_guide.md
##########
@@ -0,0 +1,77 @@
+---
+layout: page
+title: Code Guide and Tips
+subtitle: Tips in MXNet codebase for reviewers and contributors.
+action: Contribute
+action_url: /community/index
+permalink: /community/code_guide
+---
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements. See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership. The ASF licenses this file -->
+<!--- to you under the Apache License, Version 2.0 (the -->
+<!--- "License"); you may not use this file except in compliance -->
+<!--- with the License. You may obtain a copy of the License at -->
+
+<!--- http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied. See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+Code Guide and Tips
+===================
+
+This is a document used to record tips in MXNet codebase for reviewers and
+contributors. Most of them are summarized through lessons during the
+contributing and process.
+
+C++ Code Styles
+---------------
+
+- Use the [Google C/C++ style](https://google.github.io/styleguide/cppguide.html).
+- The public facing functions are documented in [doxygen](https://www.doxygen.nl/manual/docblocks.html) format.
+- Favor concrete type declaration over `auto` as long as it is short.
+- Favor passing by const reference (e.g. `const Expr&`) over passing
+ by value. Except when the function consumes the value by copy
+ constructor or move, pass by value is better than pass by const
+ reference in such cases.
+- Favor `const` member function when possible.
+- Use [RAII](https://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.
+
+We use [`cpplint`](https://github.com/cpplint/cpplint) to enforce the code style. Because
+different version of `cpplint` might change by its version, it is
+recommended to use the same version of the `cpplint` as the master.
+You can also use the following command via docker.
+
+``` {.bash}
+ci/build.py -R --docker-registry mxnetci --platform ubuntu_cpu --docker-build-retries 3 --shm-size 500m /work/runtime_functions.sh sanity_cpp
Review comment:
Not super important, but if wrap this code block inside `{% highlight bash %}` and `{% endhighlight %}`, the clipboard feature will be added in the web page and user can click the button to copy, same for all languages. See [here](https://github.com/apache/incubator-mxnet/blob/master/docs/static_site/src/_includes/get_started/linux/python/cpu/pip.md) for usage.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 edited a comment on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 edited a comment on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-679310318
Sorry I wasn't accurate about the clipboard trigger, wrapping code inside either ` ```bash ` or `{% highlight bash %}` work the same. But in the new docs, ` ``` {.bash} ` was used which won't trigger the clipboard.
I suggest reverting the last commit, and only update the new docs to use either ` ```bash ` or `{% highlight bash %}`, and not touching the rest of tutorials and api markdowns as the clipboard works on those pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
szha commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-679315706
OK
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 commented on a change in pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 commented on a change in pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#discussion_r475821182
##########
File path: docs/python_docs/themes/mx-theme/mxtheme/footer.html
##########
@@ -4,13 +4,12 @@
<div class="col-4">
<h4 class="footer-category-title">Resources</h4>
<ul class="contact-list">
- <li><a class="u-email" href="mailto:dev@mxnet.apache.org">Dev list</a></li>
- <li><a class="u-email" href="mailto:user@mxnet.apache.org">User mailing list</a></li>
- <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li>
- <li><a href="https://issues.apache.org/jira/projects/MXNET/issues">Jira Tracker</a></li>
- <li><a href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Github Roadmap</a></li>
+ <li><a href="https://lists.apache.org/list.html?dev@mxnet.apache.org">Dev list</a> (<a class="u-email" href="mailto:dev-subscribe@mxnet.apache.org">subscribe</a>)</li>
Review comment:
I can only think of hardcoding the link, but I think this work around is ok
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha commented on a change in pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
szha commented on a change in pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#discussion_r475349877
##########
File path: docs/python_docs/themes/mx-theme/mxtheme/footer.html
##########
@@ -4,13 +4,12 @@
<div class="col-4">
<h4 class="footer-category-title">Resources</h4>
<ul class="contact-list">
- <li><a class="u-email" href="mailto:dev@mxnet.apache.org">Dev list</a></li>
- <li><a class="u-email" href="mailto:user@mxnet.apache.org">User mailing list</a></li>
- <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li>
- <li><a href="https://issues.apache.org/jira/projects/MXNET/issues">Jira Tracker</a></li>
- <li><a href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Github Roadmap</a></li>
+ <li><a href="https://lists.apache.org/list.html?dev@mxnet.apache.org">Dev list</a> (<a class="u-email" href="mailto:dev-subscribe@mxnet.apache.org">subscribe</a>)</li>
Review comment:
thanks for catching it. I wasn't able to use the same reference link in python site as I did in static site, and thus made the compromise of linking to dev@ list. is there a solution with which I can link it to the same page as static site?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-679310318
Sorry I wasn't accurate about the clipboard trigger, wrapping code inside both ` ```bash ` and `{% highlight bash %}` work the same. But in the new docs, ` ``` {.bash} ` was used which won't trigger the clipboard.
I suggest reverting the last commit, and only update the new docs to use either ` ```bash ` or `{% highlight bash %}`, and not touching the rest of tutorials and api markdowns as the clipboard works on those pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] ys2843 commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
ys2843 commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-678898156
Preview link: http://ec2-34-219-134-42.us-west-2.compute.amazonaws.com/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992#issuecomment-680296625
Jenkins CI successfully triggered : [windows-gpu, unix-cpu]
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] szha merged pull request #18992: [COMMUNITY] remove mentions of JIRA, update community docs
Posted by GitBox <gi...@apache.org>.
szha merged pull request #18992:
URL: https://github.com/apache/incubator-mxnet/pull/18992
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org