Merge pull request #438 from imsnif/contact

Update CONTRIBUTING information

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

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: [email protected]
+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);

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 <network interface name>` (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: [email protected]
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License