diff --git a/source/index.txt b/source/index.txt index 4953b1a7..b5596799 100644 --- a/source/index.txt +++ b/source/index.txt @@ -27,6 +27,7 @@ Upgrade Compatibility Databases & Collections + Issues & Help .. TODO: Write Data diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt new file mode 100644 index 00000000..9217d0bf --- /dev/null +++ b/source/issues-and-help.txt @@ -0,0 +1,74 @@ +.. _ruby-issues-and-help: + +============= +Issues & Help +============= + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: ruby, troubleshooting, feedback + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +We are lucky to have a vibrant MongoDB Ruby community that +includes users with varying levels of experience using the +{+driver-short+}. The quickest way to get support for general questions +is through the :community-forum:`MongoDB Community Forums `. + +Bugs / Feature Requests +----------------------- + +If you have feedback about the {+driver-short+}, visit the `MongoDB +Feedback Engine `__ and select +:guilabel:`Drivers` from the list of products on the right side of +your screen. You can propose improvements, report issues, and provide +other types of feedback by using this site. + +You can also open a case in Jira, our issue management tool, to identify +bugs or propose improvements. The following steps describe how to create +a Jira issue: + +1. Visit the `MongoDB Jira issue tracker `__ and click the + `signup link. `__ + Create an account, and then log in to Jira. +#. Navigate to the `RUBY Jira project. `__ +#. Click :guilabel:`Create` to create a ticket. Please provide as much + information as possible about the issue or request in the ticket. + +.. note:: + + Bug reports in the RUBY Jira project are publicly viewable. + +If you've identified a security vulnerability in any official MongoDB +product, please report it according to the instructions found in the +:manual:`Create a Vulnerability Report page. ` + +Pull Requests +------------- + +We are happy to accept contributions to help improve the driver. We will guide +user contributions to ensure they meet the standards of the codebase. Please +ensure that any pull requests include documentation and tests. + +To get started, clone the source repository and work on a branch by +running the following commands: + +.. code-block:: bash + + git clone https://github.com/mongodb/mongo-ruby-driver.git + cd mongo-ruby-driver + git checkout -b myNewFeature + +.. tip:: + + If your changes correspond to a specific Jira ticket, title your pull + request by using the following convention: + + ``RUBY-``