docs(contributing): complete CONTRIBUTING.md with PR process
Swadhin Biswas committed 7 months ago
14d91f1
1 parent 8688339
commit 14d91f1
1 file changed
+57 -0
Showing 1 changed file+57-0
▼CONTRIBUTING.md
+57-0
| @@ -278,3 +278,60 @@ cargo tarpaulin --all-features | ||
278 | 278 | ### Quick Iteration |
279 | 279 | |
280 | 280 | ```bash |
281 | +# Watch mode — rebuilds on file changes (install cargo-watch first) | |
282 | +cargo install cargo-watch | |
283 | +cargo watch -x run | |
284 | + | |
285 | +# Test a specific distro logo | |
286 | +cargo run -- --ascii-distro arch | |
287 | + | |
288 | +# Test with kitty image backend | |
289 | +cargo run -- --backend kitty | |
290 | + | |
291 | +# Test JSON output | |
292 | +cargo run -- --json | jq . | |
293 | + | |
294 | +# Check binary size | |
295 | +cargo build --release && ls -lh target/release/fetchx | |
296 | +``` | |
297 | + | |
298 | +### Debugging | |
299 | + | |
300 | +```bash | |
301 | +# Run with backtrace | |
302 | +RUST_BACKTRACE=1 cargo run | |
303 | + | |
304 | +# Check what info is detected | |
305 | +cargo run -- --json 2>/dev/null | jq . | |
306 | + | |
307 | +# Test config loading | |
308 | +cargo run -- --print-config | |
309 | +``` | |
310 | + | |
311 | +### Adding a New Info Field | |
312 | + | |
313 | +1. Add detection logic in `src/system/mod.rs` | |
314 | +2. Add `show_my_field: bool` to `Config` struct in `src/config/mod.rs` | |
315 | +3. Add display logic in `src/display/mod.rs` | |
316 | +4. Add Nerd Font icon in the icon mapping | |
317 | +5. Add toggle to example config in `assets/config.example.toml` | |
318 | +6. Add tests for the detection | |
319 | +7. Update README documentation | |
320 | + | |
321 | +--- | |
322 | + | |
323 | +## Community | |
324 | + | |
325 | +- **Issues**: [GitHub Issues](https://github.com/swadhinbiswas/fetchx/issues) | |
326 | +- **Discussions**: [GitHub Discussions](https://github.com/swadhinbiswas/fetchx/discussions) | |
327 | +- **Share your rice**: Post screenshots on [r/unixporn](https://www.reddit.com/r/unixporn/) with `fetchx` tag! | |
328 | + | |
329 | +--- | |
330 | + | |
331 | +## License | |
332 | + | |
333 | +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). | |
334 | + | |
335 | +--- | |
336 | + | |
337 | +**Thank you for making FetchX better!** Every contribution, no matter how small, helps the project grow. ⚡ | |
281 | 338 | |