#2276: Add Backlog section documenting how to find a new story - #2290
#2276: Add Backlog section documenting how to find a new story#2290krystynaShatkovska wants to merge 2 commits into
Conversation
Coverage Report for CI Build 31161585568Coverage increased (+0.02%) to 72.891%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats💛 - Coveralls |
Hiepiscus
left a comment
There was a problem hiding this comment.
@krystynaShatkovska Looks good to me. The new section clearly explains how to find a suitable issue from the backlog and covers all points from the issue description. One thing I noticed, I think there is a typo in the rendered URL, so the project board link does not resolve correctly.
Update documentation/contributing/issue.adoc Co-authored-by: Hiepiscus <le-hiep.ha@capgemini.com>
hohwille
left a comment
There was a problem hiding this comment.
@krystynaShatkovska thank you for your PR. This is a great improvement. 👍
I only have marginal nice-to-have suggestions for you.
| 5. For a visual overview of all issues and their status, check the https://github.com/devonfw/IDEasy/projects/[project board]^2^. | ||
|
|
||
| IMPORTANT: Before you start working, always self-assign the issue first. | ||
| See <<working-on-an-issue, Working on an Issue>> for the detailed steps. |
There was a problem hiding this comment.
Please avoid this legacy link syntax:
| See <<working-on-an-issue, Working on an Issue>> for the detailed steps. | |
| See xref:working-on-an-issue[Working on an Issue] for the detailed steps. |
For links use:
https://external.link.com[external link]
link:other-file.adoc[other-file-link]
xref:section-ref[link-to-section-in-same-file]
link:other-file.adoc#section-reference[link-to-section-in-other-file]
Please note that we also generate PDFs from AsciiDoc and there we need to transform all kind of links to work inside the PDF was is unfortunately not supported by AsciiDoctor out of the box.
Therefore we had to implement our own logic to process and reformat such links for PDF generation (see documentation/pom.xml).
That is not relevant for this specific file but we should try to do this consistently across all AsciiDoc files because it is hard to explain every developer what file ends up in the PDF and what not.
Long time ago I wrote some AsciiDoc Guidelines for devonfw:
https://github.com/devonfw/docgen/blob/master/documentation/guidelines.asciidoc
They may not be fully up-to-date but we should maybe add our own IDEasy copy of this documentation in the contributing area to make all these things more transparent.
|
|
||
| If you are looking for a new story to work on, here is how to find one in our project backlog: | ||
|
|
||
| 1. Browse the https://github.com/devonfw/IDEasy/issues?q=is%3Aissue%20state%3Aopen%20no%3Aassignee%20label%3Aready-to-implement[open issues without an assignee and labelled *ready-to-implement*]^.1^ |
There was a problem hiding this comment.
It seems that you created your own way to support footnotes.
FYI: AsciiDoc has official support for it here.
However, it is most likely not supported by the GitHub AsciiDoc renderer so your pragmatic approach is fine.
But could you avoid these leading and or trailing dots that seem a little inconsistent/confusing to me?
This PR fixes #2276
Implemented changes:
issue query link, explanation of ready-to-implement and good-first-issue labels, consideration of Priority/Size for experienced contributors, and a reminder to self-assign
before starting work
Testing instructions
https://github.com/devonfw/IDEasy/issues?q=is%3Aissue%20state%3Aopen%20no%3Aassignee%20label%3Aready-to-implement
Checklist for this PR
Make sure everything is checked before merging this PR. For further info please also see
our DoD.
with internal
Notes: