-
Notifications
You must be signed in to change notification settings - Fork 30
Optimization with protobuf files [ECR-3472] #1177
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
Optimization with protobuf files [ECR-3472] #1177
Conversation
The Java code changes can be extracted from f00c7f9. Checkstyle does not check auto-generated code, hence there is no need to exclude that package. |
Do any instructions need to be updated? |
CONTRIBUTING.md
Outdated
Also on Mac you need a [`coreutils`](https://formulae.brew.sh/formula/coreutils) package installed. | ||
|
||
### Building | ||
__Important__: In order to retrieve submodules you have to execute `git submodule update --init` before first build. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You also need to execute git submodule update
before each build, don't you?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, the info about submodule revision is recorded under the main repo, so I believe that it makes sense executing this only after fetching updates for the main repo. And yes, it should also be stated somewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fetching updates or switching to any new branch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When one creates a new branch within the current branch with submodules that are checked out, the new branch contains the same revision to submodules and the content of submodules folders remains the same.
When one gets switched to the branch that points to a different submodule revision then git submodule update
is required I guess.
Well, the deeper we go here the more I feel like instruction turns into a guide to git for the user - wouldn't it be enough to just mention that protobuf files (or just some parts of the project) are a git submodule and user should pay attention to this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, submodule mention shall be enough.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"git submodule init
и git submodule update
" unexpected Russian :D
Looks good to me, although I'd elaborate a little for why a user needs to retrieve submodules in CONTRIBUTING.md
(to get protobuf files?)
Overview
Protobuf specification files are taken now from a separate repository that is incorporated into the main project as a git submodule.
git submodule init
иgit submodule update
should be executed in order to fetch the content of the submodule.See: https://jira.bf.local/browse/ECR-3472
Definition of Done