Skip to content

Commit f818f30

Browse files
author
Mihai Bojin
authored
docs: improve GitHub templates (#472)
1 parent 33be241 commit f818f30

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Create a bug report and help us improve our code!
44
title: ''
55
labels: ''
66
assignees: ''
77

88
---
99

1010
**Describe the bug**
11-
A clear and concise description of what the bug is.
11+
A clear and concise description of the bug.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
1515
1. Run '...'
1616
2. See error
1717

1818
**Expected behavior**
19-
A clear and concise description of what you expected to happen.
19+
Please explain what you expected to happen.
2020

2121
**Screenshots**
22-
If applicable, add screenshots to help explain your problem.
22+
If possible, add screenshots to help explain your problem.
2323

2424
**Desktop (please complete the following information):**
2525
- OS: [e.g. Ubuntu Linux 18.04]
26-
- Version [e.g. 1.2]
26+
- MongoCLI version [e.g. 1.2]
2727

2828
**Additional context**
2929
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ contact_links:
88
about: Support is provided under MongoDB Atlas or Enterprise Advance support plans.
99
- name: MongoDB Atlas
1010
url: https://www.mongodb.com/cloud/atlas
11-
about: Learn more about MongoDB Atlas
11+
about: Learn more about MongoDB Atlas.

.github/pull_request_template.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,44 @@
11
<!--
22
Thanks for contributing to MongoDB CLI!
33
4-
Before you submit your pull request, please be sure that you've reviewed our contributing guidelines: https://github.com/mongodb/mongocli/blob/master/CONTRIBUTING.md
4+
Before you submit your pull request, please review our contribution guidelines:
5+
https://github.com/mongodb/mongocli/blob/master/CONTRIBUTING.md
56
6-
Please fill out the information below to help speed the review along, and hopefully
7-
the merge of your pull request!
7+
Please fill out the information below to help speed up the review process
8+
and getting you pull request merged!
89
-->
910

1011
## Proposed changes
1112

1213
<!--
13-
Describe the big picture of your changes here and communicate why we should accept this pull request.
14+
Describe the big picture of your changes here and communicate why we should accept this pull request.
1415
If it fixes a bug or resolves a feature request, be sure to link to that issue.
1516
-->
1617

17-
_Jira ticket:_
18+
_Jira ticket:_ CLOUDP-#
1819

1920
<!--
20-
What MongoDB CLI issue does this PR address? (for example, #1234), remove this section if none
21+
What MongoDB CLI issue does this PR address? (for example, #1234), remove this section if none.
2122
-->
2223

2324
Closes #[issue number]
2425

2526
## Checklist
2627

2728
<!--
28-
Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them,
29-
don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
29+
Check the boxes that apply. If you're unsure about any of them, don't hesitate to ask!
30+
We're here to help! This is simply a reminder of what we are going to look for before merging your code.
3031
-->
3132

32-
- [] I have signed the [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement)
33-
- [] I have added tests that prove my fix is effective or that my feature works
34-
- [] I have added any necessary documentation (if appropriate)
35-
- [] I have run `make fmt` and formatted my code
33+
- [ ] I have signed the [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement)
34+
- [ ] I have added tests that prove my fix is effective or that my feature works
35+
- [ ] I have added any necessary documentation (if appropriate)
36+
- [ ] I have run `make fmt` and formatted my code
3637

3738
## Further comments
3839

3940
<!--
40-
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
41+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc.
4142
42-
Alternatively, if this is a very minor, and self-explanitory change, feel free to remove this section.
43+
Alternatively, if this is a very minor, and self-explanatory change, feel free to remove this section.
4344
-->

0 commit comments

Comments
 (0)