-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v0.5.3 Optimization of Depth Rendering (#13)
* v0.5.3 rc1 * update README * update README * fix peng-3 link * docs: improve README and CONTRIBUTING * docs: update features section in lib.rs and README * fix: update thiserror
- Loading branch information
Showing
5 changed files
with
151 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,59 @@ | ||
# Contributing to Peng Project | ||
# 🤝 Contributing | ||
|
||
Thank you for your interest in contributing! Please follow these guidelines. | ||
We welcome contributions of all kinds! Here's how you can help: | ||
|
||
## Ways to Contribute | ||
|
||
- 🐛 Bug Reports: Open detailed issues on GitHub | ||
- 💡 Feature Requests: Share ideas for improvements | ||
- 🛠️ Code Contributions: Submit pull requests | ||
- 📚 Documentation: Improve docs and examples | ||
- 🧪 Testing: Add test cases and improve coverage | ||
|
||
## Getting Started | ||
|
||
1. **Fork the repository**: Click the "Fork" button at the top right of the repository page. | ||
2. **Clone your fork**: | ||
```sh | ||
git clone https://github.com/makeecat/Peng.git | ||
``` | ||
2. **Clone your fork**: | ||
```sh | ||
git clone https://github.com/makeecat/Peng.git | ||
``` | ||
3. **Navigate to the project directory**: | ||
```sh | ||
cd Peng | ||
``` | ||
4. **Build and run the project**: | ||
```sh | ||
cargo run | ||
``` | ||
```sh | ||
cd Peng | ||
``` | ||
4. **Build and run the project**: | ||
```sh | ||
cargo run | ||
``` | ||
|
||
## How to Contribute | ||
|
||
1. **Create a new branch**: | ||
```sh | ||
git checkout -b feature/your-feature-name | ||
``` | ||
2. **Make your changes**. | ||
```sh | ||
git checkout -b feature/your-feature-name | ||
``` | ||
2. **Make your changes**. Add tests for your changes in the inline documentation. Document public APIs | ||
3. **Test your changes**. | ||
```sh | ||
cargo test | ||
cargo fmt | ||
cargo clippy -- -D warnings | ||
``` | ||
4. **Commit your changes**: | ||
```sh | ||
git commit -m "Brief description of your changes" | ||
``` | ||
```sh | ||
git commit -m "Brief description of your changes" | ||
``` | ||
5. **Push to your fork**: | ||
```sh | ||
git push origin feature/your-feature-name | ||
``` | ||
```sh | ||
git push origin feature/your-feature-name | ||
``` | ||
6. **Create a pull request**: Go to the repository on GitHub and click "New Pull Request". | ||
|
||
## License | ||
|
||
By contributing, you agree that your contributions will be licensed under the [GPL-3.0 License](LICENSE). | ||
By contributing, you agree that your contributions will be licensed under: | ||
|
||
- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT) | ||
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) | ||
|
||
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project shall be dual licensed as above, without any additional terms or conditions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
[package] | ||
exclude = ["assets/", "CONTRIBUTING.md", "CODE_OF_CONDUCT.md", "SECURITY.md"] | ||
name = "peng_quad" | ||
version = "0.5.2" | ||
version = "0.5.3" | ||
edition = "2021" | ||
rust-version = "1.76" | ||
authors = ["Yang Zhou <[email protected]>"] | ||
|
@@ -31,7 +31,7 @@ nalgebra = "0.33.0" | |
rand = { version = "0.8.5", features = ["rand_chacha"] } | ||
rand_distr = "0.4.3" | ||
rerun = "0.19.0" | ||
thiserror = "1.0.63" | ||
thiserror = "2.0.0" | ||
serde = { version = "1.0.209", features = ["derive"] } | ||
serde_yaml = "0.9.34" | ||
env_logger = "0.11.5" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters