|
| 1 | +.. _contributing-guildelines: |
| 2 | + |
| 3 | +*********************** |
| 4 | +Contributing Guidelines |
| 5 | +*********************** |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +.. contents:: On this page |
| 10 | + :local: |
| 11 | + :backlinks: none |
| 12 | + :depth: 2 |
| 13 | + :class: singlecol |
| 14 | + |
| 15 | + |
| 16 | +Contributing Guidelines |
| 17 | +======================= |
| 18 | + |
| 19 | +If you wish to propose an enhancement to Mongoid, please create a Jira ticket |
| 20 | +describing the enhancement and what it would enable you to achieve in your |
| 21 | +application that is not already possible. If you believe Mongoid is not |
| 22 | +behaving correctly, please create a Jira ticket describing how you use Mongoid, |
| 23 | +what the existing behavior is that you consider incorrect or problematic, and |
| 24 | +what your desired behavior is. If you wish to make changes yourself, the |
| 25 | +following guildelines should be followed: |
| 26 | + |
| 27 | +#. Create a fork of Mongoid. |
| 28 | +#. Create a new branch in that fork. |
| 29 | +#. Make your changes. |
| 30 | +#. Ensure that the proposed changes have adequate test coverage. |
| 31 | +#. Raise a PR against Mongoid master. If these changes correspond to a specific |
| 32 | + Jira ticket, title the PR: "MONGOID-<ticket #> Description of Changes". |
| 33 | +#. The Mongoid team will review the PR and make comments/suggest changes. |
| 34 | +#. Once all of the changes and fixes are made, and the Mongoid team determine |
| 35 | + the PR fit for merging, we will merge the PR into master and determine |
| 36 | + whether it needs to be backported. |
| 37 | +#. Backports to previous stable versions are done if the change is a bug fix, |
| 38 | + is not backwards breaking, and if the commit is applicable to the |
| 39 | + corresponding stable branch. Presently backport candidates would include |
| 40 | + versions 7.3-8.0. |
| 41 | +#. Changes to 6.0-7.2 are generally not made unless it fixes a security |
| 42 | + vulnerability. |
| 43 | +#. 5.x and earlier is generally not supported. |
0 commit comments