Skip to content

Commit 96e8ded

Browse files
authored
DOCSP-20240: added issues and help page (#21)
* DOCSP-20240: added issues and help page * test * DOCSP-20240: better introduction wording * removing ds store files
1 parent 9600909 commit 96e8ded

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

source/index.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
Configuration </configuration>
1818
FAQ </faq>
1919
What's New </whats-new>
20+
Issues and Help </issues-and-help>
2021
View the Source <{+product-source-repo+}>
2122

2223
Overview
@@ -47,6 +48,8 @@ To view answers to frequently asked questions, see the :ref:`FAQ <mongodb-analyz
4748
To view the differences between versions of the extension,
4849
see the :ref:`What's New <mongodb-analyzer-changelog>` page.
4950

51+
For further support, see the :ref:`Issues and Help <mongodb-analyzer-issues-and-help>` page.
52+
5053
.. note:: Roslyn Analyzer
5154

5255
The {+product+} is a Roslyn Analyzer. To learn more about Roslyn Analyzers, see

source/issues-and-help.txt

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. _mongodb-analyzer-issues-and-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
.. default-domain:: mongodb
8+
9+
The MongoDB developer community is highly engaged and encompasses users with a range of Visual Studio Code experience.
10+
11+
Often, the quickest way to get support for general questions is through the `MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/data/developer-tools/49/vscode>`__.
12+
13+
Refer to our :manual:`support channels </support>` documentation for more information.
14+
15+
Bugs / Feature Requests
16+
-----------------------
17+
18+
If you think you've found a bug or want to request a new MongoDB Analyzer feature, please open a case in our issue management tool, JIRA:
19+
20+
* `Create an account and login <https://jira.mongodb.org>`__.
21+
* Navigate to `the VS project <https://jira.mongodb.org/browse/VS>`__.
22+
* Click **Create**. Please provide as much information as possible about the
23+
issue and the steps to reproduce it.
24+
25+
Bug reports in JIRA for the Visual Studio project are **public**.
26+
27+
If you've identified a security vulnerability in the analyzer or any other
28+
MongoDB project, please report it according to the instructions found in the
29+
:manual:`Create a Vulnerability Report </tutorial/create-a-vulnerability-report>` page.
30+
31+
Pull Requests
32+
-------------
33+
34+
We're happy to accept contributions to help improve the analyzer. We
35+
will review user contributions to ensure they meet the standards of the
36+
codebase. Please include documentation and tests in your pull request.
37+
38+
To get started, check out the source and work on a branch:
39+
40+
.. code-block:: bash
41+
42+
git clone https://github.com/mongodb/mongo-csharp-analyzer.git
43+
cd mongo-csharp-analyzer
44+
git checkout -b myNewFeature

0 commit comments

Comments
 (0)