ni / ni/measurement-plugin-python
Provide naming guidelines for Service Class in documentation
Open
Nobody has claimed this yet.
documentation
tech debt
- Dominant language
- Python
- Stars
- 21
- Forks
- 20
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 3
Description
Tech Debt
Update the Measurement Plug-In documentation by providing guidelines to set the Service Class for the measurements in the following links:
Context
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 with the discussion in pull request #841 and compare the linked Product documentation page with the repository README. Identify where the Service Class guidance for measurements belongs in each location, then document clear naming guidelines in both places. Done means the guidelines are present and consistent across the Product documentation and README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100