Add pattern support for `about_resource` field?

Open
#598 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the ABOUT spec and the discussion in PR #539, then identify where about_resource is defined and validated in this repository. Decide whether patterns belong in a new deployed-side field or the existing field; done means the chosen spec change and its toolkit impact are documented and agreed.

Written by the indexing model from the issue text.

Description

Now we are using patterns to map to deployed resource paths, and this is also different from the about_resource field in the ABOUT spec as this is resources in the deployed side, and not present side-by-side in the devel codebase. We are currently using about_resource temporarily to have these patterns, until this spec change is accepted. But this is incorrect both because of the above reason, and that the about_resource spec does not support patterns for now.

https://github.com/aboutcode-org/aboutcode-toolkit/pull/539#issuecomment-1782270839

@pombredanne @AyanSinhaMahapatra

What’s the current status, and what plan/change needs to be made?
At present, the about_resource field is designed to reference a single resource (file or directory) at a time.

Should we introduce a new field to support patterns for about_resource on the deployed side, or should we extend the existing about_resource field to include pattern support

Dominant language
Python
Stars
100
Forks
48
PR merge metrics
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No 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.

More from aboutcode-org/aboutcode-toolkit

All issues in aboutcode-org/aboutcode-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.