Remove stub content/style section from CONTRIBUTING.md

[yangdanny97]

python/typing#1882 has added the stub content/style guidelines from CONTRIBUTING.md to the official typing documentation (https://typing.readthedocs.io/en/latest/guides/writing_stubs.html), so we can change the contributing guide to link to that directly.

I added a special note re: omitting docstrings from typeshed, since the official docs only discusses tradeoffs (per Jelle's recommendation in python/typing#1880 (comment))

[Avasam]

This reminds me of an old PR by @srittau and reviewed by @JelleZijlstra that went unmerged https://github.com/python/typeshed/pull/7594/files
I haven't gone through the whole thing yet, I'm just wondering if there's more sections that can be updated with a link.

[yangdanny97]

The only extra thing that PR deletes is the "Supported type system features" section. The comments mentioned linking to the issue tracker: project: feature tracker Tracks whether a typing feature can be used in typeshed stubs , but I don't quite understand @AlexWaygood 's comment

We could also consider using a meta-issue tracker to track the issue trackers.

Perhaps we can do that in a separate PR?

[Akuli]

I don't think this is a good idea.

I think CONTRIBUTING.md should be a self-contained document that you read, and then you can contribute. It should be as painless as possible to go through, so it shouldn't expect readers to follow links and read something elsewhere.

That said, "for more info see also" type of links are ok in a CONTRIBUTING.md.

[Akuli]

I think the Any trick is a good example of a "for more info, see also" kind of thing. Most contributors won't need to know about it, so it is IMO a good idea to link to it from CONTRIBUTING.md, but not explain it here.

[yangdanny97]

The main motivation for removing the whole section from CONTRIBUTING.md is to align on a single source of truth. If the content is duplicated across two locations, they can diverge and cause confusion if they disagree. A secondary motivation is to reduce the length of the document and to keep it focused on typeshed-specific things.

As a point of comparison, the DefinitelyTyped repo's README doesn't include detailed info on how to write typescript definitions, it links to the official docs.

https://github.com/DefinitelyTyped/DefinitelyTyped?tab=readme-ov-file#how-do-i-write-definitions-for-packages-that-can-be-used-globally-and-as-a-module