source/bandwhich
1
0
Fork 0
mirror of https://github.com/imsnif/bandwhich.git synced 2026-02-09 01:59:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING information

Browse Source
This commit is contained in:
cyqsimon
2024-10-09 23:41:46 +08:00
parent 72219da4f3
commit 9454f51882
2 changed files with 3 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -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). 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);

12
README.md
View File

@@ -190,17 +190,7 @@ Options:
## Contributing ## 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. See [CONTRIBUTING.md](CONTRIBUTING.md).
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: aram@poor.dev
## License ## License