Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change project structure #878

Merged
merged 4 commits into from
Feb 13, 2023
Merged

Change project structure #878

merged 4 commits into from
Feb 13, 2023

Conversation

canepat
Copy link
Member

@canepat canepat commented Feb 11, 2023

This PR restructures the project in order to better reflect the modular design of Silkworm and achieve the following objectives:

  • all source files of the project are contained within one folder named silkworm: this makes the project layout simpler and more intuitive for newcomers
  • the folders at the first level within such silkworm folder represent the modules composing the system: this helps to immediately find a mapping between the modular design and the source files
  • the format of the inclusion directives becomes <silkworm/mmm/...>, where mmm is one of the system modules: this enforces the clear distinction between the internal and external includes and also allows to figure out which module the included header belongs to

@codecov
Copy link

codecov bot commented Feb 11, 2023

Codecov Report

Merging #878 (be863be) into master (985f0ff) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #878      +/-   ##
==========================================
+ Coverage   70.36%   70.38%   +0.02%     
==========================================
  Files         239      239              
  Lines       18256    18256              
  Branches     2811     2811              
==========================================
+ Hits        12845    12849       +4     
+ Misses       4267     4264       -3     
+ Partials     1144     1143       -1     
Impacted Files Coverage Δ
silkworm/core/chain/config.cpp 91.55% <ø> (ø)
silkworm/core/chain/config.hpp 0.00% <ø> (ø)
silkworm/core/chain/dao.cpp 100.00% <ø> (ø)
silkworm/core/chain/difficulty.cpp 100.00% <ø> (ø)
silkworm/core/chain/genesis.cpp 80.35% <ø> (ø)
silkworm/core/chain/genesis_goerli.cpp 100.00% <ø> (ø)
silkworm/core/chain/genesis_mainnet.cpp 100.00% <ø> (ø)
silkworm/core/chain/genesis_rinkeby.cpp 100.00% <ø> (ø)
silkworm/core/chain/genesis_sepolia.cpp 100.00% <ø> (ø)
silkworm/core/chain/intrinsic_gas.cpp 100.00% <ø> (ø)
... and 335 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@canepat canepat mentioned this pull request Feb 11, 2023
@canepat canepat marked this pull request as ready for review February 11, 2023 23:49
@canepat canepat merged commit 4f4257f into master Feb 13, 2023
@canepat canepat deleted the change_project_structure branch February 13, 2023 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants