Skip to content

Commit 12829e8

Browse files
committed
update CONTRIBUTING.md including /lib guidelines
1 parent 80070de commit 12829e8

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ For this reason, you're encouraged to read the following points before submittin
88
4. reuse existing code and libraries where possible, and keep your PR small and focused, prioritizing quality over quantity
99
5. if you end up adding a UI-facing sentence, make sure to internationalize it by adding a method to the `src/translations` module with the corresponding English translation (only add other languages if you natively speak them)
1010
6. if you end up modifying the `Sniffer` struct, include the new field in the `Conf` struct if it has to be persisted across runs of the app, or else consider cleaning it up in `Sniffer::reset()` if it has to be reset at every capture session
11-
7. include unit tests to assert the implementation is sound (if applicable), and make sure that `cargo test`, `cargo clippy -- -D warnings`, and `cargo fmt --all -- --check` all pass
12-
8. be sure to update the `CHANGELOG.md` file `[UNRELEASED]` section with a one-line description of the change, including a link to the corresponding PR and issue if applicable (following the format of the existing entries)
13-
9. be mindful that reviewing the PR may take a while, especially if it introduces substantial changes
14-
10. be mindful that the contribution can still be rejected at our discretion (even if it satisfies all the points above) if it doesn't align with the project's vision or if it introduces unnecessary complexity
11+
7. if you end up modifying or creating a library in the `lib` folder, make sure to bump its version, update its own `CHANGELOG.md`, and update `Cargo.toml`'s dependencies and workspace members accordingly
12+
8. include unit tests to assert the implementation is sound (if applicable), and make sure that `cargo test`, `cargo clippy -- -D warnings`, and `cargo fmt --all -- --check` all pass
13+
9. be sure to update the `CHANGELOG.md` file `[UNRELEASED]` section with a one-line description of the change, including a link to the corresponding PR and issue if applicable (following the format of the existing entries)
14+
10. be mindful that reviewing the PR may take a while, especially if it introduces substantial changes
15+
11. be mindful that the contribution can still be rejected at our discretion (even if it satisfies all the points above) if it doesn't align with the project's vision or if it introduces unnecessary complexity
1516

1617
You can read the [_Build from source_](https://github.com/GyulyVGC/sniffnet/wiki/Build-from-source) Wiki page to learn how to set up the development environment, and the [_Code of Conduct_](https://github.com/GyulyVGC/sniffnet/blob/main/CODE_OF_CONDUCT.md) for the expected behavior in the community.
1718

0 commit comments

Comments
 (0)