search

willi19 / swpp202301-compiler-team6

MIT License
0 stars 0 forks source link

[Sprint *] Consistency of codes #16

Open sharaelong opened 1 year ago

sharaelong commented 1 year ago

During code review, I found everyone's style is considerably different, but which not in domain of good or bad. I will list up what I found here:

  1. What namespaces to use with using namespace? std and llvm combination seemed reasonable.
  2. #ifndef #endif patterns.
  3. I'm curious about this: for our new pass, we declare new class such as BranchPredictPass. Do we need to write initializer explicitly even we want to use default initializer?
  4. Naming convention, indentation level, spacing.
  5. Commit message. I heard that best practice for commit message is this: Sentence 'this commit will (your commit message).' should make sense.

I think we have to make some agreement about these issues.

willi19 commented 1 year ago

LGTM

sharaelong commented 1 year ago

Adding: It looks good to me that standardize a branch name as feat/pass-name in lowercase.

goranmoomin commented 1 year ago

FYI, I usually use the feat/ namespace for features, fix/ namespace for bugfixes, and so on.