Move contributing related info out of README to CONTRIBUTING#50543
Merged
jakebailey merged 1 commit intomicrosoft:mainfrom Aug 30, 2022
Merged
Move contributing related info out of README to CONTRIBUTING#50543jakebailey merged 1 commit intomicrosoft:mainfrom
jakebailey merged 1 commit intomicrosoft:mainfrom
Conversation
Loading
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README used in the repo is also the README that is uploaded to npm and is read by users. Right now, about 50% of the content (height-wise) is related to building/testing the TS project itself, but the average user is not going to need this info. See: https://www.npmjs.com/package/typescript#building
IMO, detailed contributing related information shouldn't be present in this file, and are better suited to CONTRIBUTING, which we already link to in a special "contribute" section.
(Potentially, the block I'm moving is redundant with other parts of CONTRIBUTING, but simplifying that file is a different PR.)