Improve documentation on rules for package name
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 711
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
I don't know if this is the right repository to log this, but the page about the package names doesn't specify the rules for naming a package.
For example, "download" is not allowed. And you can only find this out by trying to publish it, and getting an error in return
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 existing page about package names and review the current guidance against the reported publishing error for "download." Document the package-naming rules and explain restrictions that users otherwise discover only when publishing; done means the page clearly states these rules before users attempt publication.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100