Skip to content

Commit fe92b54

Browse files
committed
fix: review from @bstaletic
1 parent e23dc61 commit fe92b54

File tree

4 files changed

+28
-16
lines changed

4 files changed

+28
-16
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ Tips:
6969

7070
* You can use `virtualenv` (from PyPI) instead of `venv` (which is Python 3
7171
only).
72-
* You can select any name for your environment folder.
73-
* If you use a different shell, there are other activate scripts.
72+
* You can select any name for your environment folder; if it contains "env" it
73+
will be ignored by git.
7474
* If you don’t have CMake 3.14+, just add “cmake” to the pip install command.
7575
* You can use `-DPYBIND11_FINDPYTHON=ON` instead of setting the
7676
`PYTHON_EXECUTABLE` - the new search algorithm can find virtual environments,
@@ -105,13 +105,12 @@ The valid options are:
105105
* Use `cmake build -LH` to list the CMake options with help.
106106
* Use `ccmake` if available to see a curses (terminal) gui, or `cmake-gui` for
107107
a completely graphical interface (not present in the PyPI package).
108-
* Use `-G` and the name of a generator to use something other than `make`, like
109-
`Xcode` or `Ninja` (automatic multithread!).
108+
* Use `-G` and the name of a generator to use something different, like `Ninja`
109+
(automatic multithreading!). `cmake --help` lists the generators available.
110110
* Open the `CMakeLists.txt` with QtCreator to generate for that IDE.
111111
* Use `cmake --build build -j12` to build with 12 cores (for example).
112-
* If you are using the `llvm` tool-suite, you can use
113-
`-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to generate the .json file that the
114-
`clang-*` commands expect.
112+
* You can use `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to generate the `.json` file
113+
that some tools expect.
115114

116115
</p></details>
117116

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,14 @@ title: "[BUG] "
77

88
Make sure you've completed the following steps before submitting your issue -- thank you!
99

10-
1. Make sure you've read the [documentation](http://pybind11.readthedocs.io/en/latest/). Your issue may be addressed there.
11-
2. Consider asking first in the [Gitter chat room](https://gitter.im/pybind/Lobby).
12-
3. Include a self-contained and minimal piece of code that reproduces the problem. If that's not possible, try to make the description as clear as possible.
10+
1. Make sure you've read the [documentation][]. Your issue may be addressed there.
11+
2. Search the [issue tracker][] to verify that this hasn't already been reported. +1 or comment there if it has.
12+
3. Consider asking first in the [Gitter chat room][].
13+
4. Include a self-contained and minimal piece of code that reproduces the problem. If that's not possible, try to make the description as clear as possible.
14+
15+
[documentation]: https://pybind11.readthedocs.io
16+
[issue tracker]: https://github.com/pybind/pybind11/issues
17+
[Gitter chat room]: https://gitter.im/pybind/Lobby
1318

1419
*After reading, remove this checklist and the template text in parentheses below.*
1520

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ title: "[FEAT] "
88
Make sure you've completed the following steps before submitting your issue -- thank you!
99

1010
1. Check if your feature has already been mentioned / rejected / planned in other issues.
11-
2. If those resources didn't help, consider asking in the [Gitter chat room](https://gitter.im/pybind/Lobby) to see if this is interesting / useful to a larger audience and possible to implement reasonably,
11+
2. If those resources didn't help, consider asking in the [Gitter chat room][] to see if this is interesting / useful to a larger audience and possible to implement reasonably,
1212
4. If you have a useful feature that passes the previous items (or not suitable for chat), please fill in the details below.
1313

14+
[Gitter chat room]: https://gitter.im/pybind/Lobby
15+
1416
*After reading, remove this checklist.*

.github/ISSUE_TEMPLATE/question.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,16 @@ title: "[QUESTION] "
66

77
If you have a question, please check the following first:
88

9-
1. Check if your question has already been answered in the [FAQ](http://pybind11.readthedocs.io/en/latest/faq.html) section.
10-
2. Make sure you've read the [documentation](http://pybind11.readthedocs.io/en/latest/). Your issue may be addressed there.
11-
3. If those resources didn't help and you only have a short question (not a bug report), consider asking in the [Gitter chat room](https://gitter.im/pybind/Lobby).
12-
4. If you have a more complex question which is not answered in the previous items (or not suitable for chat), please fill in the details below.
13-
5. Include a self-contained and minimal piece of code that illustrates your question. If that's not possible, try to make the description as clear as possible.
9+
1. Check if your question has already been answered in the [FAQ][] section.
10+
2. Make sure you've read the [documentation][]. Your issue may be addressed there.
11+
3. If those resources didn't help and you only have a short question (not a bug report), consider asking in the [Gitter chat room][]
12+
4. Search the [issue tracker][], including the closed issues, to see if your question has already been asked/answered. +1 or comment if it has been asked but has no answer.
13+
5. If you have a more complex question which is not answered in the previous items (or not suitable for chat), please fill in the details below.
14+
6. Include a self-contained and minimal piece of code that illustrates your question. If that's not possible, try to make the description as clear as possible.
15+
16+
[FAQ]: http://pybind11.readthedocs.io/en/latest/faq.html
17+
[documentation]: https://pybind11.readthedocs.io
18+
[issue tracker]: https://github.com/pybind/pybind11/issues
19+
[Gitter chat room]: https://gitter.im/pybind/Lobby
1420

1521
*After reading, remove this checklist.*

0 commit comments

Comments
 (0)