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 contributing guide #1534

Merged
merged 9 commits into from
Jul 4, 2023

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Jun 30, 2023

@LysandreJik @osanseviero @julien-c Related to our recent discussion, I've update the readme and contribution guide:

  • README.md: added a logo, updated the key features and added a quick start
  • CONTRIBUTING.md: updated some outdated stuff (+also lowered the importance of pre-commit hooks) and added mention the "good first issue" list (currently empty).

My plan is to start creating / curating some good first issues and then merge this PR.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jun 30, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

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

Cool stuff 🔥

[code of conduct](https://github.com/huggingface/huggingface_hub/blob/main/CODE_OF_CONDUCT.md).

> Looking for a good first issue to work on?
> Please check out our contributing guide below and then select an issue from our [curated list](https://github.com/huggingface/huggingface_hub/contribute).
Copy link
Contributor

Choose a reason for hiding this comment

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

This is empty right now. Should we add some before merging this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I'm working on it :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

First one here 😁

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

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

looks cool!

@Wauplin
Copy link
Contributor Author

Wauplin commented Jul 4, 2023

Thanks for the reviews, I'm merging it now :)

@Wauplin Wauplin merged commit 618bb23 into main Jul 4, 2023
@Wauplin Wauplin deleted the update-readme-and-contributing-guide branch July 4, 2023 12:46
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.

4 participants