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

High-level project overview and contributing guide for ruff server #10565

Merged
merged 6 commits into from
Mar 26, 2024
Merged

High-level project overview and contributing guide for ruff server #10565

merged 6 commits into from
Mar 26, 2024

Conversation

snowsignal
Copy link
Contributor

Summary

This PR adds an overview and roadmap to the README.md for the ruff_server crate along with a rudimentary CONTRIBUTING.md that explains some of the technical decisions behind the project and basic information about local testing.

@snowsignal snowsignal added the documentation Improvements or additions to documentation label Mar 25, 2024
@snowsignal snowsignal force-pushed the jane/server/contributing branch from 9cf65e3 to 8642f23 Compare March 25, 2024 10:30
@snowsignal snowsignal force-pushed the jane/server/contributing branch from 8642f23 to b74f7dd Compare March 25, 2024 10:33
MichaReiser
MichaReiser approved these changes Mar 25, 2024
View reviewed changes
Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

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

Nice write up. It gives a good overview of the core concepts and the design decisions behind it. Thanks for taking the time for writing this up. I've a few smaller comments on how I think the documentation could be improved.

dhruvmanila
dhruvmanila approved these changes Mar 25, 2024
View reviewed changes
Copy link
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

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

Thank you!

@snowsignal snowsignal merged commit 825fd7c into main Mar 26, 2024
16 checks passed
@snowsignal snowsignal deleted the jane/server/contributing branch March 26, 2024 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VascoSch92 VascoSch92 VascoSch92 left review comments

@MichaReiser MichaReiser MichaReiser approved these changes

@dhruvmanila dhruvmanila dhruvmanila approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@snowsignal @MichaReiser @dhruvmanila @VascoSch92