testcontainers / testcontainers-rs-modules-community

Community maintained modules for Testcontainers for Rust
https://docs.rs/crate/testcontainers-modules/
MIT License
75 stars 41 forks source link

Improve documentation of the crate #2

Open DDtKey opened 1 year ago

DDtKey commented 1 year ago

We need to enrich the crate with documentation

Depends on #1

### Tasks
- [x] Contribution guide - @ubiratansoares is assigned
- [x] Improve crate-level documentation (docs.rs)
- [ ] Document usage of each existing module
- [x] Align readme with documentation
- [x] New issue template
- [x] Activate `#![deny(missing_docs)]` at crate level to avoid missing documentation
ghost commented 9 months ago

Anything I can do to help?

DDtKey commented 9 months ago

Two remaining tasks are:

I would be glad for any help

ghost commented 9 months ago

Okay I'll have a go at adding documentation for the use of each module and submit a PR.

ubiratansoares commented 6 months ago

@DDtKey Is there anyone assigned to Contribution Guidelines? If not, I'd love helping with that! 🙂

DDtKey commented 6 months ago

No, feel free to take on this task! Thank you!🙏

DDtKey commented 4 months ago

To actualize the state: We still need to cover undocumented modules. But there is no need to document all of them at once.

I'm happy to accept PRs with documentation for 1 module at a time.