Update documentation to note that you can use sentences in labels
Open
Nobody has claimed this yet.
feature request
- Dominant language
- TypeScript
- Stars
- 2.5k
- Forks
- 492
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/Prowlarr/Prowlarr/blob/develop/.github/labeler.yml
Was able to see that you are allowed to do this:
'Area: API':
- changed-files:
- any-glob-to-any-file:
- src/Prowlarr.Api.V1/**/*
'Area: Db-migration':
- changed-files:
- any-glob-to-any-file:
- src/NzbDrone.Core/Datastore/Migration/*
And that you are no restricted to only alphanumeric no space labels. This would have been handy to know in the readme.
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 repository README and review the linked .github/labeler.yml example for the label syntax being documented. Update the documentation to state that labels may contain spaces and sentence-like text, then verify the example and wording are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100