WIP: Start of Good Design Practices

[miguelraz]

I think I like where these slides are going.

We'll scaffold a small is_pangram library and handle a few corner cases as enums as we hit them.

I think it's a good (and brief enough) story that should work as slides.

Making the pull request to get some early feedback.

[jonathanpallant]

I like the idea of building a small library with best practices, however:

• We already introduce 'shapes' as an exercise for building a library
• There's a lot of code in these slides - it feels like more an exercise than a slide deck

Proposal:

We write a high-quality example library (shapes, or pangram, or whatever) and we stick it in the repo under rust-training/examples. We then point to the examples from the slides, and call out various components.

Some things we should highlight:

• Putting everything in lib.rs vs using sub-modules and pub use submodule::Thing
• Choosing between struct A, struct B, impl A, impl B or struct A, impl A, struct A, impl A
• Warning about missing documentation
• Fuzzing or other advanced test functions
• Doctests
• What it looks like if you cargo doc --open
• Making types not-pub if the user of the library doesn't need to know about them

[Mirabellensaft]

This overlaps a lot with what we planned for simple_db and shapes, but it is bit more detailed and explicit but not different enough to be its own thing at this point. So my proposal would be to basically start where simple_db stops, and focus on the points not mentioned there.

[jonathanpallant]

A first-pass short version is in #47. We can add more material later if required. Some of this material can also be moved into a more advanced/detailed deck if desired.

[jonathanpallant]

@miguelraz do you want to finish this one up or close it for now?

[jonathanpallant]

Ping @miguelraz again.

[miguelraz]

Closing until we have a better reason to open this up again.