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

docs(rust, python): Improve contributing guide #5558

Merged
merged 3 commits into from
Nov 21, 2022
Merged

docs(rust, python): Improve contributing guide #5558

merged 3 commits into from
Nov 21, 2022

Conversation

stinodego
Copy link
Contributor

@stinodego stinodego commented Nov 20, 2022 •
edited
Loading

Resolves #4695

  • Overhaul the contributing guide
    • I will not list all the changes; please just go through the guide to see if you have any remarks / are missing something!
    • I removed the remarks about licensing, as it feels redundant. We have the LICENSE file, it should be enough for legal reasons. I have not seen similar sections in other contributing guides.
  • Update a .gitignore file as building the Python API reference created a bunch of unignored files.
  • Add a help command to the Rust makefile (this needs more love - but I added this super basic version because the new contributing guide says the help command exists).

I'd like to add a section for maintainers on the release flow, but I don't know exactly what Ritchie is doing at the moment so I'll leave that for later 😄

Feedback is very welcome!

@github-actions github-actions bot added the docs label Nov 20, 2022
@stinodego stinodego marked this pull request as ready for review November 20, 2022 10:30
@stinodego stinodego changed the title docs: Improve contributing guide docs(rust, python): Improve contributing guide Nov 20, 2022
@github-actions github-actions bot added python Related to Python Polars rust Related to Rust Polars labels Nov 20, 2022
zundertj
zundertj approved these changes Nov 20, 2022
View reviewed changes
Copy link
Collaborator

@zundertj zundertj left a comment

Choose a reason for hiding this comment

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

Looks very good, I don't see any gaps and it all flows nicely! Well done.

@ritchie46 ritchie46 merged commit ca50f7b into pola-rs:master Nov 21, 2022
@stinodego stinodego added the documentation Improvements or additions to documentation label Jan 19, 2023
@stinodego stinodego deleted the contributing branch February 22, 2023 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zundertj zundertj zundertj approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Contributing guide needs to be improved
3 participants
@stinodego @zundertj @ritchie46