Skip to content

Commit

Permalink
update bug and feature templates (#4147)
Browse files Browse the repository at this point in the history
* update bug and feature templates

* fix broken link + add whatsnew
  • Loading branch information
bjlittle authored May 19, 2021
1 parent 83309c3 commit 18d5629
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ Steps to reproduce the behaviour:
<summary>Click to expand <b>this section...</b></summary>

```
Add additional verbose information in a collapsible section.
Please add additional verbose information in this section e.g., code, output, tracebacks, screenshots etc
```
See [here](https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab) for further details.
</details>

3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ assignees: ''
<summary>Click to expand <b>this section...</b></summary>

```
Add additional verbose information in a collapsible section.
Please add additional verbose information in this section e.g., references, screenshots, listings etc
```
See [here](https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab) for further details.
</details>

2 changes: 1 addition & 1 deletion docs/src/developers_guide/contributing_code_formatting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ linted according to our ``.flake8`` configuration file. Note that,
for each ``.pre-commit-config.yaml`` git hook.

Additionally, you may wish to enable ``black`` for your preferred
`editor/IDE <https://black.readthedocs.io/en/stable/editor_integration.html#editor-integration>`_.
`editor/IDE <https://black.readthedocs.io/en/stable/integrations/editors.html#editor-integration>`_.

With the ``pre-commit`` configured, the output of performing a ``git commit``
will look similar to::
Expand Down
4 changes: 4 additions & 0 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ This document explains the changes made to Iris for this release
#. `@jamesp`_ switched `cirrus-ci`_ testing and `nox`_
testing to use `conda-lock`_ files for static test environments. (:pull:`4108`)

#. `@bjlittle`_ updated the ``bug-report`` and ``feature-request`` GitHub issue
templates to remove an external URL reference that caused un-posted user issue
content to be lost in the browser when followed. (:pull:`4147`)

.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
core dev names are automatically included by the common_links.inc:
Expand Down

0 comments on commit 18d5629

Please sign in to comment.