From 9989ec98e857b9c1ebf88cafdbd500413378ca93 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Sat, 20 Apr 2019 18:09:59 +0200 Subject: [PATCH] Add contributor note about `cargo-sync-readme` --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 65a979e..431a0ed 100644 --- a/README.md +++ b/README.md @@ -380,7 +380,13 @@ Please report a panic in this crate immediately as issue on [github](https://git Even if the crate itself is panic free, it allows the user to define custom functions that are executed by the crate. The user needs to ensure that the function he provides to the crate never panic. -## Closing Notes +## Contribution If you have any ideas for features or see any problems in the code, architecture, interface, algorithmics or documentation, please open an issue on github. If there is already an issue describing what you want to say, please add a thumbs up or whatever emoji you think fits to the issue, so I know which ones I should prioritize. + +**Notes for contributors:** + + * This crate uses the [`sync-readme`](https://github.com/phaazon/cargo-sync-readme) cargo subcommand to keep the documentation in `src/lib.rs` and `README.md` in sync. + The subcommand only syncs from the documentation in `src/lib.rs` to `README.md`. + So please alter the documentation in the `src/lib.rs` rather than altering anything in between `` and `` in the `README.md`. \ No newline at end of file