README vs CONTRIBUTING #5422
Assignees
Labels
project: policy
Organization of the typeshed project
Comments
|
Sounds good, I'd also prefer to keep README short. Thanks for bringing this up! We could even add a third file (say SPECIFICATION.md) for the exhaustive detail on things like METADATA and VERSIONS, which isn't relevant to most contributors. |
hauntsaninja
pushed a commit
that referenced
this issue
May 12, 2021
This shuffles sections around between README.md and CONTRIBUTING.md. CONTRIBUTING now contains information pertaining to opening PRs, README all other information. I have also moved the list of maintainers to a separate file. I have kept most information intact for now, with two main exceptions: I removed duplicated information. For brevity's sake, I trimmed some explanations from the section about version checks. I have restructured the CONTRIBUTING file to follow the order of the introductory "contribution process at a glance" section. This now serves as a bit of a table of contents. Closes: #5422
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I just wanted to add information about the new supported
METADATAfields, but I was a bit unsure on where to add them. We have a certain duplication betweenREADMEandCONTRIBUTING. For example, the directory structure and theVERSIONSfile is described in both files.My suggestion: Move the sections "Directory structure" and "Running the tests" into
CONTRIBUTING. Split "Directory structure" into "Stubs for the Python Standard Library" and "Stubs for Third-party Library" and partly merge the "Stub versioning" section into those sections. Then we can descriptionVERSIONSin the stdlib section andMETADATAin the third-party section. README will be kept fairly short, and everything to do with development is inCONTRIBUTING.The text was updated successfully, but these errors were encountered: