Issues & Help
On this page
We are lucky to have a vibrant MongoDB Ruby community that includes users with varying levels of experience using Mongoid and the Ruby driver. The quickest way to get support for general questions is through the MongoDB Community Forums.
Bugs / Feature Requests
If you have feedback about Mongoid, visit the MongoDB Feedback Engine and select 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:
Visit the MongoDB Jira issue tracker and click the signup link. Create an account, and then log in to Jira.
Navigate to the MONGOID Jira project.
Click 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 MONGOID 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 Create a Vulnerability Report guide.
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, tests, and pass code checks. To learn about Mongoid's code documentation conventions, see the Code Documentation guide.
To get started, clone the source repository and work on a branch by running the following commands:
git clone https://github.com/mongodb/mongoid.git cd mongoid git checkout -b my-new-feature
Tip
If your changes correspond to a specific Jira ticket, title your pull request by using the following convention:
MONGOID-<ticket #>: <description of changes>
The Mongoid developer team will review your pull request and make comments or suggest changes.