Skip to content

Commit c6aec73

Browse files
authored
Update new issue template
1 parent dec31a0 commit c6aec73

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
You are about to open an issue for the MongoDB PHP library. If you instead
12+
intended to report an issue with the MongoDB PHP extension, please do so via its
13+
repository[^1].
14+
15+
If you've identified a security vulnerability in a driver or any other MongoDB
16+
project, please create a vulnerability report[^2].
17+
18+
[^1]: https://github.com/mongodb/mongo-php-driver
19+
[^2]: https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report
20+
-->
21+
22+
### Bug Report
23+
24+
<!--
25+
Briefly describe the issue. Feel free to cross-reference your report with any
26+
other related GitHub or JIRA issues for additional context. Before reporting an
27+
issue, check that you are using the most recent version of the driver.
28+
-->
29+
30+
### Environment
31+
32+
<!--
33+
What operating system and PHP version are you using? Mention if PHP was
34+
installed through a third-party bundle (e.g. MAMP, XAMPP) and report its version
35+
if applicable.
36+
37+
What version of MongoDB are you using? Include details about the topology (e.g.
38+
replica set, sharded cluster) and how you are connecting to the database (e.g.
39+
TLS connections, authentication). If possible, share your connection string and
40+
additional URI options (be sure to redact any auth credentials). Please specify
41+
whether you are self-hosting the database or using a cloud provider, such as
42+
MongoDB Atlas.
43+
44+
Include version information for the extension, libmongoc, and libbson. This may
45+
be collected by grepping phpinfo() output:
46+
47+
php -i | grep -E 'mongodb|libmongoc|libbson'
48+
49+
In some cases, it may be helpful to provide all phpinfo() output (e.g. `php -i`)
50+
and/or list all installed extensions (e.g. `php -m`).
51+
52+
Include version information for the library. This may be
53+
collected by running the following from your project's root directory:
54+
55+
composer show mongodb/mongodb
56+
-->
57+
58+
### Test Script
59+
60+
<!--
61+
If possible, attach a complete PHP script that can be executed on its own to
62+
reproduce the issue. Clarify whether this script can be run from the CLI or if
63+
it can must be run through a web SAPI.
64+
65+
If the error only presents itself in a web SAPI, note whether the issue can be
66+
reproduced with PHP's built-in web server[^3]. If not, please share your web
67+
server version and any relevant configuration details in the Environment section
68+
above.
69+
70+
[^3]: http://php.net/manual/en/features.commandline.webserver.php
71+
-->
72+
73+
### Expected and Actual Behavior
74+
75+
<!--
76+
How did the script fail to perform the expected task? Feel free to include debug
77+
and/or `var_dump()` output if that helps explain the error.
78+
79+
If the observed behavior is an unexpected exception, please include its full
80+
message and any relevant backtrace information. If you encountered a
81+
segmentation fault, please include a GDB backtrace[^4].
82+
83+
[^4]: https://bugs.php.net/bugs-generating-backtrace.php
84+
-->
85+
86+
### Debug Log
87+
88+
<!--
89+
If the issue relates to internal driver behavior (e.g. connection issues),
90+
please include a debug log[^5]. This may be generated by setting the
91+
`mongodb.debug` INI option to "stderr" or a directory (useful for web SAPIs).
92+
93+
[^5]: https://www.php.net/manual/en/mongodb.configuration.php#ini.mongodb.debug
94+
-->

0 commit comments

Comments
 (0)