Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add content from typeshed/CONTRIBUTING.md #1882

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

yangdanny97
Copy link
Contributor

@yangdanny97 yangdanny97 commented Nov 7, 2024

This PR merges non-typeshed-specific content on writing stubs into main typing guide.

https://github.com/python/typeshed/blob/main/CONTRIBUTING.md

This would let us reference this guide from typeshed's CONTRIBUTING.md and delete the duplicate sections.

#1880

@@ -113,18 +118,6 @@ Stub Content
This section documents best practices on what elements to include or
leave out of stub files.

Modules excluded fom stubs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved this down cuz it felt weird for the "stub content" section to start with "what you shouldn't include"

@yangdanny97 yangdanny97 marked this pull request as ready for review November 13, 2024 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant