Add high-level architecture documentation#5456
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Thank you for your contribution! ❤️You can try out this pull request locally by installing Rollup via npm install rollup/rollup#architecture-documentationNotice: Ensure you have installed Rust nightly. If you haven't installed it yet, please first see https://www.rust-lang.org/tools/install to learn how to download Rustup and install Rust, then see https://rust-lang.github.io/rustup/concepts/channels.html to learn how to install Rust nightly. or load it into the REPL: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5456 +/- ##
=======================================
Coverage 98.79% 98.79%
=======================================
Files 238 238
Lines 9449 9449
Branches 2407 2407
=======================================
Hits 9335 9335
Misses 48 48
Partials 66 66 ☔ View full report in Codecov by Sentry. |
|
This PR has been released as part of rollup@4.14.2. You can test it via |
|
This PR contains:
Are tests included?
Breaking Changes?
List any relevant issue numbers:
Description
In the past, I have been very reluctant to document the code too much in the past to avoid the burden of maintaining out-dated documentation as the code changes. However as I want to start doing workshops in my company to find new contributors, I found that I very much need some high-level documentation that people can read to find their way around in the code.
This is a first attempt, and I hope we will be able to adapt it as major refactorings happen.