Skip to content

Add default readme for crates#1102

Merged
phil-opp merged 3 commits intodora-rs:mainfrom
chrislearn:readme
Aug 19, 2025
Merged

Add default readme for crates#1102
phil-opp merged 3 commits intodora-rs:mainfrom
chrislearn:readme

Conversation

@chrislearn
Copy link
Copy Markdown
Contributor

@chrislearn chrislearn commented Aug 16, 2025

I noticed that many dora crates on crates.io don't have a readme file.
I set them to the default readme file.

@haixuanTao
Copy link
Copy Markdown
Collaborator

haixuanTao commented Aug 16, 2025

Seems like we can't release README that is within parent folder according to the CI/CD:

warning: readme `../../README.md` appears to be a path outside of the package, but there is already a file named `README.md` in the root of the package. The archived crate will contain the copy in the root of the package. Update the readme to point to the path relative to the root of the package to remove this warning.

@chrislearn chrislearn marked this pull request as draft August 16, 2025 06:12
@chrislearn chrislearn marked this pull request as ready for review August 16, 2025 09:32
phil-opp
phil-opp approved these changes Aug 19, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@phil-opp phil-opp left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes!

@phil-opp phil-opp merged commit 843dcb7 into dora-rs:main Aug 19, 2025
128 of 207 checks passed
@chrislearn chrislearn deleted the readme branch December 29, 2025 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@phil-opp phil-opp phil-opp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@chrislearn @haixuanTao @phil-opp