spangaer commented on code in PR #36: URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017763314
########## CONTRIBUTING.md: ########## @@ -293,28 +288,22 @@ All wire protocol changes that may concern rolling upgrades should be documented ### Protobuf -Akka includes a shaded version of protobuf `3` that is used for internal communication. To generate files, +Pekko includes a shaded version of protobuf `3` that is used for internal communication. To generate files, run `protobufGenerate`. The generated files are put in each project's `src/main/java` and need to be committed. The generated files are automatically transformed to use the shaded version of protobuf. Generation depends on protoc `3.11.4` being on the path. See [protobuf project](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation) for installation instructions, and -[Protobuf.scala](https://github.com/akka/akka/blob/main/project/Protobuf.scala) for details of how to override +[Protobuf.scala](https://github.com/apache/incubator-pekko/blob/main/project/Protobuf.scala) for details of how to override the settings for generation. ### Pull request requirements For a pull request to be considered at all, it has to meet these requirements: 1. Regardless if the code introduces new features or fixes bugs or regressions, it must have comprehensive tests. -1. The code must be well documented in the Lightbend's standard documentation format (see the 'Documentation' section below). +1. The code must be well documented as per the existing documentation format (see the 'Documentation' section below). 1. The commit messages must properly describe the changes. See further below. 1. A pull request must be [linked to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) it aims to resolve in the PR's description (or comments). This can be achieved by writing "Fixes #1234" or similar in PR description. -1. All Lightbend projects must include Lightbend copyright notices. Each project can choose between one of two approaches: - - 1. All source files in the project must have a Lightbend copyright notice in the file header. - 1. The Notices file for the project includes the Lightbend copyright notice and no other files contain copyright notices. See <https://www.apache.org/legal/src-headers.html> for instructions for managing this approach for copyrights. Review Comment: I will chase that. I'm gathering some feedback here #38 on an initial proposal before I send it there. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@pekko.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@pekko.apache.org For additional commands, e-mail: notifications-h...@pekko.apache.org
