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

Update README and add Contributing documentation #50

Merged
merged 2 commits into from
Nov 27, 2024

Conversation

RRosio
Copy link
Collaborator

@RRosio RRosio commented Nov 27, 2024

  • Add back the build status badge, requirements, as well as install and uninstall steps in ReadMe
  • Add back documentation on contributing to extension development in a separate file

@RRosio RRosio added the documentation Improvements or additions to documentation label Nov 27, 2024
@RRosio RRosio added the maintenance General tasks for project upkeep label Nov 27, 2024
@RRosio
Copy link
Collaborator Author

RRosio commented Nov 27, 2024

I think re-introducing these key sections to the README.md might be helpful and at the same time will not introduce too much content. Also, it would be nice to have the development install instructions in the jupyter-fsspec repository via a CONTRIBUTING.md file, as those instructions are currently not documented here.

I will go ahead and merge this to move things forward, but we can revisit and discuss this further in the future to consider other perspectives and ideas!

@RRosio RRosio merged commit f133b2f into fsspec:main Nov 27, 2024
8 checks passed
@RRosio RRosio deleted the contributing branch November 27, 2024 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance General tasks for project upkeep
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant