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.

Sign up for GitHub

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

Jump to bottom

Add a README file for the red_knot crate #15979

Open
InSyncWithFoo opened this issue Feb 5, 2025 · 0 comments
Open

Add a README file for the red_knot crate #15979

InSyncWithFoo opened this issue Feb 5, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference

Comments

@InSyncWithFoo
Copy link
Contributor

InSyncWithFoo commented Feb 5, 2025 •
edited by AlexWaygood
Loading

As Red Knot is now "officially" public knowledge, the crate should at least have a short informational user-facing README explaining what it is, what its goals and non-goals are as well as what state it is currently in.

Such a file would serve as the single source of truth, which might help with attracting more potential contributors.
@MichaReiser MichaReiser added documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference labels Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MichaReiser @InSyncWithFoo