Skip to content

Commit eddd01b

Browse files
authored
Create CONTRUBUTING.md (#895)
* Create CONTRUBUTING.md * redo * pics * notes * changes * no longer have improvement category in JIRA
1 parent 8e49113 commit eddd01b

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

CONTRUBUTING.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Contributing to `docs-ecosystem`📝
2+
3+
Thank you for your interest in contributing to `docs-ecosystem`! In this
4+
guide, you can find guidelines for contributing to the MongoDB Drivers
5+
Ecosystem documentation.
6+
7+
You might want to contribute to this repository to fix a bug
8+
or error in the documentation, or if you want to add information about a
9+
feature or concept that is not currently covered. See the following
10+
section to learn more about how you can suggest changes and additions.
11+
12+
> **NOTE:** This documentation is open-source but wholly managed by the Drivers &
13+
> Connectors Documentation team at MongoDB. If you have any questions
14+
> about the documentation, contributions, or other topics, you can
15+
> contact someone on our team by emailing
16+
> [deved-team\@10gen.com](mailto:[email protected]).
17+
18+
## How can I contribute? 📤
19+
20+
The Drivers & Connectors Documentation team uses GitHub to manage and
21+
review all changes. To suggest any changes, you should create a **ticket**
22+
and then open a **pull request** against this repository.
23+
24+
### Creating a ticket ✉️
25+
26+
Our team uses JIRA, a project management software, to track issues and
27+
feature requests in the form of tickets. Before you make any changes,
28+
consider looking for [an existing
29+
ticket](https://jira.mongodb.org/projects/DOCS/issues/) in our JIRA
30+
project that addresses your idea or bug fix request.
31+
32+
If you don't find an appropriate ticket, you can create a ticket in the
33+
`DOCS` JIRA project that describes the bug, issue, or content request.
34+
In your ticket, please include the following details:
35+
36+
- Who you are
37+
- A description of the bug/issue/feature/explanation
38+
- The changes you plan to make
39+
40+
Please also fill out the following ticket fields:
41+
42+
- Issue Type: Bug/Task
43+
- A bug is an error in the documentation. For example, if you notice a
44+
typo or an error in a code example, mark the ticket as a `Bug`
45+
- A `Task` is not a `Bug`. For example, if you want to add more detail to a
46+
topic explanation, mark the ticket as an `Improvement`.
47+
- Summary: The ticket's title
48+
- Component: `Drivers`
49+
50+
Once you create the ticket, you can either decide to let us process the
51+
ticket and make the pull request, or open the PR yourself.
52+
53+
### Opening a PR 🖇️
54+
55+
To develop a PR, you can clone the `docs-ecosystem` repository and create a
56+
branch off of `master`. It is helpful if your branch name contains some
57+
details about the changes, such as `query-code-bug-fix` or
58+
`add-timeseries-explanation`.
59+
60+
After you push your changes, open a PR against the `master` branch and
61+
fill out the template with details such as the corresponding ticket link
62+
and the self-review checklist.
63+
64+
> **NOTE:** You will not be able to see your changes in a staging
65+
> environment. When a team member is reviewing your PR, we might be able
66+
> to add a staging link so that we can visualize the changes.
67+
68+
Once you have created a pull request, **do not automatically merge**.
69+
Wait for a team member to take further action.
70+
71+
### Next steps ⏰
72+
73+
You can expect that someone on our team will see the ticket and/or PR
74+
**within one week**. After this, they will leave a review on the PR which
75+
you can respond to, or they will take over the PR and manage it
76+
internally by merging changes into a new PR or addressing the ticket
77+
through a different approach.
78+
79+
Thank you again for being interested in our documentation! 🙂
80+
81+
## Useful Links 🔗
82+
83+
- [MongoDB Documentation Style
84+
Guide](https://www.mongodb.com/docs/meta/style-guide/): This guide
85+
describes best practices for write documentation relating to grammar, style,
86+
terminology, and more.
87+
- [MongoDB Documentation Site](https://www.mongodb.com/docs/): The
88+
landing page for all MongoDB documentation.
89+
- [MongoDB Client Libraries](https://www.mongodb.com/docs/drivers/): The
90+
landing page for MongoDB drivers.
91+
- [All Open DOCS JIRA
92+
Issues](https://jira.mongodb.org/projects/DOCS/issues/DOCS-15871?filter=allopenissues):
93+
The list of open documentation tickets in JIRA.

0 commit comments

Comments
 (0)