Refresh README.md, CONTRIBUTING.md #11413
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was prompted by python#11403 Changes include: - General streamlining of markdown - Remove outdated references, e.g. to Python 2 / how to install Python 3 - Mention the "type school" discussions repo, typing-sig mailing list - Remove roadmap, since there isn't really a mypy core team anymore - More concretely link to "good first issue" page, etc. Hopefully this is a better experience than the somewhat common case of gitter posts like "I know Python, please help me contribute" that don't really go anywhere - Consolidate contributing information in CONTRIBUTING.md - Remove issue tracker conventions, since the template does a pretty good job and the rest is either common sense or never looked at
TH3CHARLie
approved these changes
Oct 31, 2021
Collaborator
TH3CHARLie
left a comment
TH3CHARLie
left a comment
There was a problem hiding this comment.
Nice refreshment! Thanks for doing this!
Co-authored-by: Xuanda Yang <[email protected]>
Contributor
|
One other change that I'd like to see that's related to this is making the developer documentation more prominent. Right now, the link to the developer documentation is barely mentioned once at the bottom of CONTRIBUTING.md, which makes it very easy to not notice that it exists unless you're specifically looking for developer documentation. I think we could improve this by moving that link to either the top of CONTRIBUTING.md or the Contributing section of the README. |
Collaborator
|
very reasonable, feel free to make a PR |
tushar-deepsource
pushed a commit
to DeepSourceCorp/mypy
that referenced
this pull request
Jan 20, 2022
This was prompted by python#11403 Changes include: - General streamlining of markdown - Remove outdated references, e.g. to Python 2 / how to install Python 3 - Mention the "type school" discussions repo, typing-sig mailing list - Remove roadmap, since there isn't really a mypy core team anymore - More concretely link to "good first issue" page, etc. Hopefully this is a better experience than the somewhat common case of gitter posts like "I know Python, please help me contribute" that don't really go anywhere - Consolidate contributing information in CONTRIBUTING.md - Remove issue tracker conventions, since the template does a pretty good job and the rest is either common sense or never looked at
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This was prompted by #11403
Changes include:
is a better experience than the somewhat common case of gitter posts
like "I know Python, please help me contribute" that don't
really go anywhere
good job and the rest is either common sense or never looked at