openjs-foundation / package-json-research Goto Github PK

@Ethan-Arrowood and @joesepi said they'd create the proposal.

More info on collab spaces here, but collab spaces are basically meant to be a more collaborative working group. https://github.com/openjs-foundation/cross-project-council/blob/main/collaboration-spaces/COLLABORATION_NETWORK.md

What are "URL-safe characters"?

• Is this based on the WHATWG URL specification or something else?
• Relevant stackoverflow: https://stackoverflow.com/questions/695438/what-are-the-safe-characters-for-making-urls
• Is the validation for this in the npm cli open-source?

Let's get some automated consistency from the beginning. I'd like to add a markdown linter that has a reasonable set of rules. I don't want to bikeshed config options so preference for something equivalent to Prettier that makes the decision for us.

The linter/formatter should run on commit (lets use husky + lint-staged).

There should be a GitHub Action that runs the linter/formatter and blocks the PR from being merged until it is passing.

As mentioned here, there is reason to believe that the name property is not actually optional in practice.

More research should be done regarding npm cli's usage of the property in various commands. If the lack of the name property causes anything but publishing to fail we must document that behavior.

I've seen these before but never set one up myself. I'd like us to have some sort of link-checking cron job. It should check all links in our markdown documents and alert us when one 404s. The job should open an issue automatically reporting the 404'ing URL.

I don't think it should be apart of the lint step. Someone else work should not be blocked because another URL stopped working.