-
Notifications
You must be signed in to change notification settings - Fork 10
DOCSP-44292: improve i&h #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,73 @@ | ||||||
.. _kotlin-sync-issues-and-help: | ||||||
|
||||||
============= | ||||||
Issues & Help | ||||||
============= | ||||||
|
||||||
.. facet:: | ||||||
:name: genre | ||||||
:values: reference | ||||||
|
||||||
.. meta:: | ||||||
:keywords: kotlin sync, troubleshooting, feedback | ||||||
|
||||||
.. contents:: On this page | ||||||
:local: | ||||||
:backlinks: none | ||||||
:depth: 1 | ||||||
:class: singlecol | ||||||
|
||||||
We are lucky to have a vibrant MongoDB {+language+} 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 </tag/kotlin>`. | ||||||
|
||||||
Bugs / Feature Requests | ||||||
----------------------- | ||||||
|
||||||
If you have feedback about the {+driver-short+}, visit the `MongoDB | ||||||
Feedback Engine <https://feedback.mongodb.com/>`__ 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 <https://jira.mongodb.org/>`__ and click the | ||||||
`signup link. <https://account.mongodb.com/account/register>`__ | ||||||
Create an account, and then log in to Jira. | ||||||
#. Navigate to the `JAVA Jira project. <https://jira.mongodb.org/browse/JAVA>`__ | ||||||
#. 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 JAVA 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. </tutorial/create-a-vulnerability-report>` | ||||||
|
||||||
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 the | ||||||
**gradle** checks. | ||||||
|
||||||
To get started check out the source and work on a branch: | ||||||
|
||||||
.. code-block:: bash | ||||||
|
||||||
$ git clone https://github.com/mongodb/mongo-java-driver.git | ||||||
$ cd mongo-java-driver | ||||||
$ git checkout -b myNewFeature | ||||||
|
||||||
Finally, ensure that the code passes gradle checks. | ||||||
|
Finally, ensure that the code passes gradle checks. | |
Finally, ensure that the code passes gradle checks by running the following command: |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S:
Suggested change
$ ./gradlew check | |
./gradlew check |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: I think you can reword this code intro slightly; also, you can remove the $ from the code example