Consistent naming of package parameter
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 5
- Forks
- 5
- Avg merge
- 6h 35m
- Merged PRs (30d)
- 3
Description
Currently, there are several parameter names for a package. The descriptions also vary quite a bit.
packageescapedPackageNamepackage_namepackage-name
Suggestion
Consolidate these to packageName (in alignment with orgName and teamName).
Description: The name of a package. Must be URL-encoded. In particular, for scoped packages, "/" must be replaced by "%2f".
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
Search the API documentation for package, escapedPackageName, package_name, and package-name, then compare nearby orgName and teamName parameters. Done means the package parameter consistently uses packageName and the description matches the specified URL-encoding guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- handlebars
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100