Skip to content

Commit b7e219d

Browse files
authored
DOCSP-46862 Issues & Help (#139)
* DOCSP-46862 Issues & Help * edits * internal review * weird build fail * build mysteriously good again
1 parent c3375b0 commit b7e219d

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
Upgrade </upgrade>
2929
Compatibility </compatibility>
3030
Databases & Collections </databases-collection>
31+
Issues & Help </issues-and-help>
3132

3233
.. TODO:
3334
Write Data </write>

source/issues-and-help.txt

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
.. _ruby-issues-and-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: ruby, troubleshooting, feedback
13+
14+
.. contents:: On this page
15+
:local:
16+
:backlinks: none
17+
:depth: 1
18+
:class: singlecol
19+
20+
We are lucky to have a vibrant MongoDB Ruby community that
21+
includes users with varying levels of experience using the
22+
{+driver-short+}. The quickest way to get support for general questions
23+
is through the :community-forum:`MongoDB Community Forums </tag/ruby>`.
24+
25+
Bugs / Feature Requests
26+
-----------------------
27+
28+
If you have feedback about the {+driver-short+}, visit the `MongoDB
29+
Feedback Engine <https://feedback.mongodb.com/>`__ and select
30+
:guilabel:`Drivers` from the list of products on the right side of
31+
your screen. You can propose improvements, report issues, and provide
32+
other types of feedback by using this site.
33+
34+
You can also open a case in Jira, our issue management tool, to identify
35+
bugs or propose improvements. The following steps describe how to create
36+
a Jira issue:
37+
38+
1. Visit the `MongoDB Jira issue tracker <https://jira.mongodb.org/>`__ and click the
39+
`signup link. <https://account.mongodb.com/account/register>`__
40+
Create an account, and then log in to Jira.
41+
#. Navigate to the `RUBY Jira project. <https://jira.mongodb.org/browse/RUBY>`__
42+
#. Click :guilabel:`Create` to create a ticket. Please provide as much
43+
information as possible about the issue or request in the ticket.
44+
45+
.. note::
46+
47+
Bug reports in the RUBY Jira project are publicly viewable.
48+
49+
If you've identified a security vulnerability in any official MongoDB
50+
product, please report it according to the instructions found in the
51+
:manual:`Create a Vulnerability Report page. </tutorial/create-a-vulnerability-report>`
52+
53+
Pull Requests
54+
-------------
55+
56+
We are happy to accept contributions to help improve the driver. We will guide
57+
user contributions to ensure they meet the standards of the codebase. Please
58+
ensure that any pull requests include documentation and tests.
59+
60+
To get started, clone the source repository and work on a branch by
61+
running the following commands:
62+
63+
.. code-block:: bash
64+
65+
git clone https://github.com/mongodb/mongo-ruby-driver.git
66+
cd mongo-ruby-driver
67+
git checkout -b myNewFeature
68+
69+
.. tip::
70+
71+
If your changes correspond to a specific Jira ticket, title your pull
72+
request by using the following convention:
73+
74+
``RUBY-<ticket #>``

0 commit comments

Comments
 (0)