openjs-foundation / package-json-research

20 stars 3 forks source link

Add more details regarding research process #7

Closed Ethan-Arrowood closed 10 months ago

Ethan-Arrowood commented 1 year ago

After working through some research for the name field I realized that we should clarify exactly what the analysis should include. I don't want to see (or waste my own time) researching how an endless number of package managers utilize various properties. Instead, I want the research to focus on exactly how the properties should be defined in a package.json.

I've included an example that I hope makes sense to help further demonstrate the clarification

darcyclarke commented 1 year ago

I think I understand now what you were explaining on our call just now in regards to trying to map/research values vs. usage. That said, I still think it will be hard to reason about what values could be without understanding usage. You're going to find, as I have historically, that the documentation for these values is often incomplete or inaccurate & the truth lays in the code that ingests them.

Ethan-Arrowood commented 10 months ago

@darcyclarke & @ljharb I've rewritten the section to reflect our recent meeting discussion. Please review and let me know your thoughts 😄