Perl-Toolchain-Gang / Perl-Toolchain-Gang/Module-Metadata

should package_versions_from_directory return local or unix paths?

Open
#25 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Perl
Stars
8
Forks
17
PR merge metrics
No merged PRs in 30d

Description

In the fixing of #24 the question came up as to what kind of paths that function should return. I'm leaving this issue here to mark this as something needing to be decided.

@karenetheridge's input so far:

(ether) it's probably undefined (yay)
(ether) we should just figure out which way makes sense and document it
(ether) ->provides should return canonical (unixified) I think, since one of its usecases is to be stuffed into distribution metadata

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating package_versions_from_directory and examining the callers that consume its paths. Resolve whether the function should return local or canonical Unix paths, then document the chosen contract and verify the expected path form in relevant tests or examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
perl
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.