cqframework / cqframework/cqf-tooling
Add description and example of stub Measure resource necessary to kick-off refresh of dQM content
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 22
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
The refresh operation requires a base Measure resource in order to run for dQMs but the details are shop knowledge.
It would be useful if those requirements were documented and there was an example.
The alternative would be to include prompting for those minimal set of requirements as part of the refresh operation. The operation would detect the minimal requirements have not been met and ask the user to supply them. This would continue until the minimal requirements were met.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the refresh operation for dQMs and locating any existing documentation or examples for a base Measure resource. Confirm the minimal required fields with project maintainers or existing project knowledge, then document those requirements and include a representative stub Measure example; done when users can prepare the resource and start a refresh without relying on undocumented knowledge.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100