mroot/yazi
1
0
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2026-07-25 08:41:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Changes made

Browse source
This commit is contained in:
Johan Naizu 2024-05-18 11:36:24 +05:30 • committed by GitHub
parent cfb227ada9
commit 4dc21053bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -49,16 +49,26 @@ yazi/
└── README.md # Project overview └── README.md # Project overview
``` ```
## Development Setup ## Development Setup
1. Ensure Rust is installed: 1. Ensure Rust is installed:
```sh ```sh
rustc --version rustc --version
cargo --version cargo --version
```
2. Build the project: 2. Build the project:
```sh ```sh
cargo build cargo build
```
3. Run the tests: 3. Run the tests:
```sh ```sh
cargo test cargo test
```
4. Format the code (requires the nightly version of `rustfmt`):
```sh
rustup component add rustfmt --toolchain nightly
rustfmt +nightly **/*.rs
```
## How to Contribute ## How to Contribute
### Reporting Bugs ### Reporting Bugs
@ -66,29 +76,34 @@ If you find a bug, please create an issue
### Suggesting Features ### Suggesting Features
If you have a feature request, please create an issue If you have a feature request, please create an issue
### Improving Documentation ### Improving Documentation
Improvements to documentation are always welcome! Please make sure to follow the same pull request process as for code changes. Yazi's documentation repository is located at [yazi-rs.github.io](https://github.com/yazi-rs/yazi-rs.github.io). Contributions related to documentation need to be made within this repository.
### Submitting Code Changes ### Submitting Code Changes
1. Create a new branch for your changes: 1. Create a new branch for your changes:
```sh ```sh
git checkout -b feature/your-feature-name git checkout -b feature/your-feature-name
```
2. Make your changes. Ensure that your code follows the project's coding standards and passes all tests. 2. Make your changes. Ensure that your code follows the project's coding standards and passes all tests.
3. Commit your changes with a descriptive commit message: 3. Commit your changes with a descriptive commit message:
```sh ```sh
git commit -m "Add feature: description of the feature" git commit -m "Add feature: description of the feature"
```
4. Push your changes to your fork: 4. Push your changes to your fork:
```sh ```sh
git push origin feature/your-feature-name git push origin feature/your-feature-name
```
## Pull Request Process ## Pull Request Process
1. Ensure your fork is up-to-date with the upstream repository: 1. Ensure your fork is up-to-date with the upstream repository:
```sh ```sh
git fetch upstream git fetch upstream
git checkout main git checkout main
git merge upstream/main git merge upstream/main
```
2. Rebase your feature branch onto the main branch: 2. Rebase your feature branch onto the main branch:
```sh ```sh
git checkout feature/your-feature-name git checkout feature/your-feature-name
git rebase main git rebase main
```
3. Create a pull request to the `main` branch of the upstream repository. Follow the pull request template and ensure that: 3. Create a pull request to the `main` branch of the upstream repository. Follow the pull request template and ensure that:
- Your code passes all tests and lints. - Your code passes all tests and lints.
- Your pull request description clearly explains the changes and why they are needed. - Your pull request description clearly explains the changes and why they are needed.