Skip to content

docs: add CONTRIBUTING.md #1052

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
Merged
sxyazi merged 5 commits into from
May 18, 2024
Merged

docs: add CONTRIBUTING.md #1052

sxyazi merged 5 commits into from
May 18, 2024

Conversation

@johan-naizu
Copy link
Contributor

@johan-naizu johan-naizu commented May 17, 2024

Fixes #1051

@sxyazi
Copy link
Owner

sxyazi commented May 18, 2024

Thank you, please also add this information:

  • Yazi currently requires the nightly version of rustfmt and it can be called by rustfmt +nightly **/*.rs for formatting if the Rust environment is managed by rustup.
  • Yazi's documentation repository is located at https://github.com/yazi-rs/yazi-rs.github.io. Contributions related to documentation need to be made within this repository.

sxyazi
sxyazi reviewed May 18, 2024
View reviewed changes
CONTRIBUTING.md
1. Ensure Rust is installed:
```sh
rustc --version
cargo --version
Copy link
Owner

@sxyazi sxyazi May 18, 2024

Choose a reason for hiding this comment

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

End tag is missing here

@johan-naizu
Copy link
Contributor Author

johan-naizu commented May 18, 2024

I have made the changes

@sxyazi sxyazi changed the title Add CONTRIBUTING.md docs: add CONTRIBUTING.md May 18, 2024
sxyazi
sxyazi approved these changes May 18, 2024
View reviewed changes
Copy link
Owner

@sxyazi sxyazi left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@sxyazi sxyazi merged commit 0ff4835 into sxyazi:main May 18, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sxyazi sxyazi sxyazi 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.

Add CONTRIBUTING.md

2 participants

@johan-naizu @sxyazi