rust icon indicating copy to clipboard operation
rust copied to clipboard

Project structure and Design decisions

Open allentv opened this issue 4 years ago • 2 comments

Hi. I am a beginner in Rust and was looking for issues that I can start working on. Unfortunately there was only 1 atm which seems to have been worked on.

I was wondering if there is a GDoc or a wiki page that I can refer to understand how the project is structured, some of the high level design decisions and a list of what are good to haves for the crate.

allentv avatar Jan 03 '21 18:01 allentv

There isn't anything like that at the moment, although it sounds like a good idea. Do you have any specific questions that I could use as a starting point?

adamcrume avatar Jan 04 '21 19:01 adamcrume

  • An overview of how code is structured
  • High level summary of what each package is meant for
  • Any specific testing tools used
  • Some examples of how to navigate the code
  • Any assumptions that might be overlooked

allentv avatar Jan 05 '21 08:01 allentv