Versioning and Authorship for module/class/role/unit
Open
Nobody has claimed this yet.
docs
SPEC?
update
- Dominant language
- Raku
- Stars
- 308
- Forks
- 288
- Avg merge
- 3d 49m
- Merged PRs (30d)
- 2
Description
:ver<> and :auth<> (see: https://docs.perl6.org/language/typesystem#Versioning_and_Authorship) is:
- not referenced here: https://docs.perl6.org/language/modules#use
- confusingly mentioned here: https://docs.perl6.org/language/modules#is_export
To clarify the doc, we should answer these questions:
- can the adverbs ver and auth be used everywhere where a module/class/role/unit is created and consumed?
- what is the canonical source of author? Are there certain limits when creating it (does it need an email address, how must it be formatted)? When consuming it, should it refer to a github handle, CPAN user, free text as defined in the module metadata?
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 Versioning and Authorship section at docs.perl6.org/language/typesystem and the use and is_export sections at docs.perl6.org/language/modules. Determine the documented rules for ver and auth when creating and consuming module, class, role, and unit declarations, then update the affected documentation so the answers and author-format guidance are consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100