-
Notifications
You must be signed in to change notification settings - Fork 76
Expand file tree
/
Copy pathREADME.tpl
More file actions
110 lines (82 loc) · 4.24 KB
/
README.tpl
File metadata and controls
110 lines (82 loc) · 4.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
[](./LICENSE)
[](https://crates.io/crates/orderbook-rs)
[](https://crates.io/crates/orderbook-rs)
[](https://github.com/joaquinbejar/OrderBook-rs/stargazers)
[](https://github.com/joaquinbejar/OrderBook-rs/issues)
[](https://github.com/joaquinbejar/OrderBook-rs/pulls)
[](https://github.com/joaquinbejar/OrderBook-rs/actions)
[](https://codecov.io/gh/joaquinbejar/OrderBook-rs)
[](https://libraries.io/github/joaquinbejar/OrderBook-rs)
[](https://docs.rs/orderbook-rs)
{{readme}}
## 🛠 Makefile Commands
This project includes a `Makefile` with common tasks to simplify development. Here's a list of useful commands:
### 🔧 Build & Run
```sh
make build # Compile the project
make release # Build in release mode
make run # Run the main binary
```
### 🧪 Test & Quality
```sh
make test # Run all tests
make fmt # Format code
make fmt-check # Check formatting without applying
make lint # Run clippy with warnings as errors
make lint-fix # Auto-fix lint issues
make fix # Auto-fix Rust compiler suggestions
make check # Run fmt-check + lint + test
```
### 📦 Packaging & Docs
```sh
make doc # Check for missing docs via clippy
make doc-open # Build and open Rust documentation
make create-doc # Generate internal docs
make readme # Regenerate README using cargo-readme
make publish # Prepare and publish crate to crates.io
```
### 📈 Coverage & Benchmarks
```sh
make coverage # Generate code coverage report (XML)
make coverage-html # Generate HTML coverage report
make open-coverage # Open HTML report
make bench # Run benchmarks using Criterion
make bench-show # Open benchmark report
make bench-save # Save benchmark history snapshot
make bench-compare # Compare benchmark runs
make bench-json # Output benchmarks in JSON
make bench-clean # Remove benchmark data
```
### 🧪 Git & Workflow Helpers
```sh
make git-log # Show commits on current branch vs main
make check-spanish # Check for Spanish words in code
make zip # Create zip without target/ and temp files
make tree # Visualize project tree (excludes common clutter)
```
### 🤖 GitHub Actions (via act)
```sh
make workflow-build # Simulate build workflow
make workflow-lint # Simulate lint workflow
make workflow-test # Simulate test workflow
make workflow-coverage # Simulate coverage workflow
make workflow # Run all workflows
```
ℹ️ Requires act for local workflow simulation and cargo-tarpaulin for coverage.
## Contribution and Contact
We welcome contributions to this project! If you would like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the project still builds and all tests pass.
4. Commit your changes and push your branch to your forked repository.
5. Submit a pull request to the main repository.
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project
maintainer:
### **Contact Information**
- **Author**: Joaquín Béjar García
- **Email**: jb@taunais.com
- **Telegram**: [@joaquin_bejar](https://t.me/joaquin_bejar)
- **Repository**: <https://github.com/joaquinbejar/OrderBook-rs>
- **Documentation**: <https://docs.rs/orderbook-rs>
We appreciate your interest and look forward to your contributions!
**License**: MIT