From 9454f5188288d475b046b216fbfbb7dd32211384 Mon Sep 17 00:00:00 2001 From: cyqsimon <28627918+cyqsimon@users.noreply.github.com> Date: Wed, 9 Oct 2024 23:41:46 +0800 Subject: [PATCH 1/2] Update CONTRIBUTING information --- CONTRIBUTING.md | 3 ++- README.md | 12 +----------- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff82cca70..1b6731dbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,4 +10,5 @@ After tests, check the formatting: `cargo fmt -- --check` Note that at the moment the tests do not test the os layer (anything in the `os` folder). -If you are stuck, unsure about how to approach an issue or would like some guidance, you are welcome to contact: aram@poor.dev +If you are stuck, unsure about how to approach an issue or would like some guidance, +you are welcome to [open an issue](https://github.com/imsnif/bandwhich/issues/new); diff --git a/README.md b/README.md index ce32f1873..538ef7fe4 100644 --- a/README.md +++ b/README.md @@ -190,17 +190,7 @@ Options: ## Contributing -Contributions of any kind are very welcome. If you'd like a new feature (or found a bug), please open an issue or a PR. - -To set up your development environment: -1. Clone the project -2. `cargo run`, or if you prefer `cargo run -- -i ` (you can often find out the name with `ifconfig` or `iwconfig`). You might need root privileges to run this application, so be sure to use (for example) sudo. - -To run tests: `cargo test` - -Note that at the moment the tests do not test the os layer (anything in the `os` folder). - -If you are stuck, unsure about how to approach an issue or would like some guidance, you are welcome to contact: aram@poor.dev +See [CONTRIBUTING.md](CONTRIBUTING.md). ## License From 6f0778f2e22fe203dd7848cfac084366e4f0532f Mon Sep 17 00:00:00 2001 From: cyqsimon <28627918+cyqsimon@users.noreply.github.com> Date: Wed, 9 Oct 2024 23:45:02 +0800 Subject: [PATCH 2/2] Write changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3cd115a03..db54a51a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] +### Fixed + +* Update CONTRIBUTING information #438 - @YJDoc2 @cyqsimon + ### Changed * Add build optimizations for release binary #434 - @pando85