Ownership of `@node-core/remark-lint`

[avivkeller]

As we move to the new generator, @node-core/remark-lint contains updated rules and plugins to best accommodate this change. However, these changes will reflect in node core (once the remark plugin is switched out, after the initial doc-kit migration is complete), therefore, who should own the code responsible for performing this linting?

While I think that it's unreasonable to ping every collaborator to such a change, it may make sense to add @nodejs/linting or @nodejs/documentation as code owners of the content (probably also @nodejs/web-infra, since they are responsible for the generators, and should be aware of potential lint changes).

cc @nodejs/collaborators

[avivkeller]

Note that the current implementation, remark-preset-lint-node, does not have a CODEOWNER

[ovflowd]

This issue should be moved to @nodejs/node as I believe it pertains there.

[ovflowd]

cc @nodejs/collaborators I believe your input here is valuable as this directly affets how your API docs get linted and respectively how you write API docs. We're fine housing the ownership, but it'd make sense to have shared-ownership or at least a heads-up to a subset of members to be pinged if changes to our remark-lint package are done.

cc @Trott any thoughts?

[Trott]

or at least a heads-up to a subset of members to be pinged if changes to our remark-lint package are done.

Maybe that would be @nodejs/linting? @nodejs/documentation might sorta kinda apply too. Both teams could probably stand to have around half of the current members removed as inactive. In practice, they're smaller teams than they might first appear to be.

cc @Trott any thoughts?

Not really. My main concern is that we continue the practice of not landing any changes to the linting package (currently remark-preset-lint-node) that will cause linting failures in the node or TSC repositories. If we want to make a breaking change, we have to fix the markdown files in those repos first.

Otherwise, I don't have much of an opinion.

[avivkeller]

The goal, as discussed with @Ethan-Arrowood, is to define a "spec" of some sort, to make this documentation format work on multiple OpenJS projects, and not be limited to Node.js.

The "spec", and thus, lint rules, will come from the current documentation format, along with constraints that any generators may have. I'd like there to be minimal breaking changes, and allow for minimal breaking documentation.

I'm happy to add those teams as code owners, but either they should be trimmed (since CODEOWNERS have write access), or we wait until the CODEOWNER review comment PR lands on the website (which could take some time).

[github-actions]

This issue has been marked as stale due to 210 days of inactivity.
It will be automatically closed in 30 days if no further activity occurs. If this is still relevant, please leave a comment or update it to keep it open.