Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "unwanted coverage" to user documentation #431

Open
koppor opened this issue Sep 6, 2024 · 1 comment · May be fixed by #434
Open

Add "unwanted coverage" to user documentation #431

koppor opened this issue Sep 6, 2024 · 1 comment · May be fixed by #434
Labels
documentation User guides, turorials, specifications

Comments

@koppor
Copy link

koppor commented Sep 6, 2024

I have a simple project setup.

### Chatting with AI
`req~ai.chat.new-message-based-on-previous~1`
            } else if (keyEvent.getCode() == KeyCode.UP) {
                // [impl->req~ai.chat.new-message-based-on-previous~1]

Now, I get

[unwanted coverage] ← impl~ai.chat.new-message-based-on-previous-2709826873~0

As beginner user, I expect that https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md days something about the case.


Are the artifact types at https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md#specification-item-id hard-coded in the system?

It seems that they are hard-coded in the system. Then, the following sentence needs to be rewritten:

While not enforced by OFT the following strings are well established:


Maybe at https://github.com/itsallcode/openfasttrace/blob/main/doc/user_guide.md#writing-a-specification?

The solution to my concrete case is to add following to the requirement:

Needs: impl
@redcatbear redcatbear added the documentation User guides, turorials, specifications label Jan 6, 2025
@redcatbear
Copy link
Collaborator

There are no hard-coded artifact types in OFT. That is part of the acknowledgement that "one-size-fits-all" does not really work in all projects.

"Unwanted coverage" means that the specification item (in this case a code tag) claims to cover something, but the thing it points to does not exist. That happens usually when there is a typo in the requirement ID.

But you are right, the handbook should definitely explain what "unwanted coverage" means.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User guides, turorials, specifications
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants