diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 77f3b24bfa..5f65470c82 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -33,8 +33,7 @@ Steps to reproduce the behaviour: Click to expand this section... ``` -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. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 382dc5cfbf..b17b6066e4 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -20,8 +20,7 @@ assignees: '' Click to expand this section... ``` -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. diff --git a/docs/src/developers_guide/contributing_code_formatting.rst b/docs/src/developers_guide/contributing_code_formatting.rst index 1a3573d135..6d48882652 100644 --- a/docs/src/developers_guide/contributing_code_formatting.rst +++ b/docs/src/developers_guide/contributing_code_formatting.rst @@ -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 `_. +`editor/IDE `_. With the ``pre-commit`` configured, the output of performing a ``git commit`` will look similar to:: diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 250ac143c7..7c5b1f04ae 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -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: