search

iomentum / cargo-breaking

Mozilla Public License 2.0
112 stars 7 forks source link

Dev-guide #11

Open scrabsha opened 3 years ago

scrabsha commented 3 years ago

It would be a nice idea to have some documentation that describe briefly how things work. This would make contributions easier for newcomers.

cbonaudo commented 3 years ago

Are you speaking about each mod specifically (eg: doc for git.rs, doc for glue.rs, etc...) ?

scrabsha commented 3 years ago

Yep! where each thing happen, how data flows between each pass, and so on. Maybe we can take inspiration from Overview of the Compiler from the rustc dev guide.

cbonaudo commented 3 years ago

Created in #15, with a brief summary. now we can expand each part to describe accurately what is done