cjolivier01 closed pull request #10344: [MXNET-87] Add JIRA info to docs URL: https://github.com/apache/incubator-mxnet/pull/10344
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/docs/community/contribute.md b/docs/community/contribute.md index 9c3c3e18702..e3d10f527dc 100644 --- a/docs/community/contribute.md +++ b/docs/community/contribute.md @@ -6,6 +6,22 @@ After your patch has been merged, remember to add your name to [CONTRIBUTORS.md] ## Code Contribution +Before you start coding… + +… please make sure there is a JIRA issue that corresponds to your contribution. This is a general rule that the MXNet community follows for all code contributions, including bug fixes, improvements, or new features, with an exception for trivial hot fixes. If you would like to fix a bug that you found or if you would like to add a new feature or improvement to MXNet, please follow the [File a bug report or Propose an improvement or a new feature](http://mxnet.io/community/index.html) guidelines to open an issue in [MXNet’s JIRA](http://issues.apache.org/jira/browse/MXNet) before starting with the implementation. + +If the description of a JIRA issue indicates that its resolution will touch sensible parts of the code base, be sufficiently complex, or add significant amounts of new code, the MXNet community might request a design document (most contributions should not require a design document). The purpose of this document is to ensure that the overall approach to address the issue is sensible and agreed upon by the community. JIRA issues that require a design document are tagged with the requires-design-doc label. The label can be attached by any community member who feels that a design document is necessary. A good description helps to decide whether a JIRA issue requires a design document or not. The design document must be added or attached to or link from the JIRA issue and cover the following aspects: + +- Overview of the general approach<br/> +- List of API changes (changed interfaces, new and deprecated configuration parameters, changed behavior, …)<br/> +- Main components and classes to be touched<br/> +- Known limitations of the proposed approach<br/> + +A design document can be added by anybody, including the reporter of the issue or the person working on it.<br/> + +Contributions for JIRA issues that require a design document will not be added to MXNet’s code base before a design document has been accepted by the community with lazy consensus. Please check if a design document is required before starting to code. + + ### Core Library - Follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) for C++ code. diff --git a/docs/community/index.md b/docs/community/index.md index e8b2ab97f6a..c81fa8af0dc 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -2,8 +2,17 @@ ## Questions about Using MXNet If you need help with using MXNet, have questions about applying it to a particular kind of problem, or have a discussion topic, please use our [forum](https://discuss.mxnet.io). -## Issue Tracker -We track bugs and new feature requests in the MXNet Github repo in the issues folder: [mxnet/issues](https://github.com/apache/incubator-mxnet/issues). +## File a bug report +Please let us know if you experienced a problem with MXNet and file a bug report. Open [MXNet’s JIRA](http://issues.apache.org/jira/browse/MXNet) and click on the blue `Create` button at the top. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem.<p/> +Issues may also be entered on github: [mxnet/issues](https://github.com/apache/incubator-mxnet/issues). Github issues are synced to JIRA periodically. Thank you very much. + +## Propose an improvement or a new feature +Our community is constantly looking for feedback to improve Apache MXNet. If you have an idea how to improve MXNet or have a new feature in mind that would be beneficial for MXNet users, please open an issue in [MXNet’s JIRA](http://issues.apache.org/jira/browse/MXNet). The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:<br/> +- It ensures your requirements are met when the improvement or feature is implemented.<br/> +- It helps to estimate the effort and to design a solution that addresses your needs. <br/> +- It allows for constructive discussions that might arise around this issue. + +Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the [contributions](http://mxnet.io/community/contribute.html) guide in this case as well. ## Contributors MXNet has been developed and is used by a group of active community members. Contribute to improving it! For more information, see [contributions](http://mxnet.io/community/contribute.html). ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
