Document Status labels for issues.
authorM. Eric Irrgang <mei2n@virginia.edu>
Thu, 26 Aug 2021 22:13:51 +0000 (22:13 +0000)
committerMark Abraham <mark.j.abraham@gmail.com>
Thu, 26 Aug 2021 22:13:51 +0000 (22:13 +0000)
docs/dev-manual/change-management.rst
docs/dev-manual/reportstyle.rst

index d42aa60c00778d351b9ece3fbd7a54e8225b14c3..6a3d1de9a3d321600ab72588fc50bcba476183f4 100644 (file)
@@ -88,7 +88,8 @@ Bad names: branch1234, mybranch, test, etc
 Labels
 ======
 
-Labels <https://docs.gitlab.com/ee/user/project/labels.html>`__ help developers by allowing additional filtering of issues and merge requests.
+`Labels <https://docs.gitlab.com/ee/user/project/labels.html>`__
+help developers by allowing additional filtering of issues and merge requests.
 
 The GROMACS project `defines many labels <https://gitlab.com/gromacs/gromacs/-/labels>`__.
 
index ab10d377b770ff20fc2ad0f06fa80db0ae68081c..416e69fccf7c54d75018ee5901618a983e0037bb 100644 (file)
@@ -53,6 +53,9 @@ Please refrain from setting things such as target version or deciding on unreaso
 to fix the issue on your own, please adhere to the other standards mentioned on the related pages
 :ref:`code-formatting` and :ref:`code-commitstyle`.
 
+.. seealso:: :doc:`contribute`
+
+.. _issue workflow:
 
 General issue workflow
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -62,6 +65,22 @@ The general issue workflow is shown in the figure below:
 .. image:: redmine-states.png
    :alt:  Sample procedure pathway for reported issues.
 
+Project maintainers will apply
+`Status labels <https://gitlab.com/gromacs/gromacs/-/labels?search=status>`__
+as the issue is processed.
+
+* `Status::Accepted <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3AAccepted>`__:
+  Bug confirmed / Desirable feature.
+* `Status::In Progress <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3AIn+Progress>`__:
+  Assignee starts to work.
+* `Status::Blocked <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3ABlocked>`__: Progress requires feedback or other action.
+* `Status::Rejected <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3ARejected>`__:
+  Invalid report or not a desirable feature.
+* `Status::Fix uploaded <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3AFix+uploaded>`__:
+  Merge request is available for review
+* `Status::Feedback-wanted <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3AFeedback-wanted>`__: Resolution pending additional feedback or response
+* `Status::Resolved <https://gitlab.com/gromacs/gromacs/-/issues?label_name%5B%5D=Status%3A%3AResolved>`__:
+  The issue will be closed if there is no further discussion.
 
 .. Text below is stolen from the old Gromacs web page