Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move "how to" guides as appendices #334

Open
adaaaam opened this issue Oct 30, 2024 · 3 comments
Open

Move "how to" guides as appendices #334

adaaaam opened this issue Oct 30, 2024 · 3 comments
Labels
Ecma specification Work on the core specification

Comments

@adaaaam
Copy link

adaaaam commented Oct 30, 2024

To better clarify the specification, I suggest we move the How to build purl string from its components and How to parse a purl string in its components sections into appendices. These are important to support the PURL specification but not part of the specification and better organized as appendices to the specification.

@adaaaam
Copy link
Author

adaaaam commented Oct 30, 2024

Another step in this process is reviewing any rules in the "how to" guides and confirming that are included in the Rules for each purl component section.

@adaaaam adaaaam changed the title Move "how to" guides to new repo Move "how to" guides as appendices Oct 30, 2024
@matt-phylum
Copy link
Contributor

I think with the current state of the specification they are an integral part of the specification and removing them will lead to ambiguity, particularly with weird PURLs like pkg:npm/@angular/cli or pkg:generic/name@v/1. Maybe adding more tests to the test suite would be better than trying to make everyone manually review their implementations against the steps in the file (many implementations, including official implementations, do not do follow this procedure).

Other, better known specifications follow this same pattern of including a pseudocode implementation of the spec in the spec to ensure that implementations behave consistently for edge cases.

@adaaaam
Copy link
Author

adaaaam commented Oct 30, 2024

@matt-phylum agreed that they are important to include for clarifying the processes of building and parsing PURLs. this issue is suggesting moving them to the end of the specification to improve the readability of the spec itself.

we are planning work to add more tests to the test suite along with a PURL validation mechanism.

@johnmhoran johnmhoran added the Ecma specification Work on the core specification label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ecma specification Work on the core specification
Projects
None yet
Development

No branches or pull requests

3 participants