You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by GitBox <gi...@apache.org> on 2022/11/08 13:01:10 UTC
[GitHub] [incubator-pekko] samikrc opened a new pull request, #36: Updated references from akka to pekko #28
samikrc opened a new pull request, #36:
URL: https://github.com/apache/incubator-pekko/pull/36
Updated three markdown files:
- CONTRIBUTING.md
- README.md
- RELEASING.md
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] hen commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
hen commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020578191
##########
CONTRIBUTING.md:
##########
@@ -68,18 +62,17 @@ We encourage changes that make it easier to achieve our goals efficiently.
The steps below describe how to get a patch into the main development branch (`main`).
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
-1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka/issues) and [existing pull requests](https://github.com/akka/akka/pulls) for existing work.
- - If there is no ticket yet, feel free to [create one](https://github.com/akka/akka/issues/new) to discuss the problem and the approach you want to take to solve it.
-1. [Fork the project](https://github.com/akka/akka#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
+1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko/issues) and [existing pull requests](https://github.com/apache/incubator-pekko/pulls) for existing work.
+ - If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko/issues/new) to discuss the problem and the approach you want to take to solve it.
+1. [Fork the project](https://github.com/apache/incubator-pekko#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
1. Create a branch on your fork and work on the feature. For example: `git checkout -b custom-headers-akka-http`
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
Review Comment:
Agreed; "includes the proper copyright headers" is goodness. Just need to determine what that is in each situation :) Though whether a verifyCodeStyle task is used will depend on the complexity.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1016902706
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
Done.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] spangaer commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
spangaer commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017066476
##########
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:
Given that all source files will receive a significant change by the rename and will likely evolve away from the Lightbend original from there. Shouldn't we come up with a copy right header which merges the existing lightbend header with the ASF one.
To be approved by Apache legal of course.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020179251
##########
RELEASING.md:
##########
@@ -50,9 +50,6 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
-Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
-
Review Comment:
Where are you seeing this? If you look at the most recent commit, I have only retained information for creating local snapshot. Can you please confirm?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1016618677
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
we don't have gitter - can you remove that? - maybe suggest https://github.com/apache/incubator-pekko/discussions
##########
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:
New rules for licenses:
* existing files with copyright statements must leave those copyright statements in tact
* new files should have an Apache license header instead
##########
RELEASING.md:
##########
@@ -51,7 +51,7 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
+https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/pekko/
Review Comment:
can you remove this section about snapshots - we can replace it when we have nightly builds
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017070008
##########
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:
my response is based on https://lists.apache.org/thread/z0r4sr4kdvmh52mlhc5porot2sh1wtok
there will be a need to have 2 copyrights in some files but it won't happen yet - the plan for next few months is minimal changes (we only need to have 2 licenses headers when we have a file with significant Lightbend input and significant Apache input) - we can agree what the 2 copyright header looks like - but it is not urgent - the 2 copyright header could be as simple as having the existing Lightbend license and then the Apache license after it
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017080773
##########
README.md:
##########
@@ -2,10 +2,10 @@ Apache Pekko
============
Apache Pekko is an open-source framework for building applications that are concurrent, distributed, resilient and elastic.
+Pekko uses the Actor Model to provide more intuitive high-level abstractions for concurrency.
+Using these abstractions, Pekko also provides libraries for persistence, streams, HTTP, and more.
Review Comment:
fair enough, I never use a comma before `and` but I understand why it can be used here
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning merged pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning merged PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020120540
##########
CONTRIBUTING.md:
##########
@@ -473,21 +462,21 @@ not needed to use `sbt scalafmtAll` when editing with IntelliJ.
PR validation includes checking that the Scala sources are formatted and will fail if they are not.
-Akka prefers flattened imports rather than grouped, which helps reduce merge conflicts.
+Pekko prefers flattened imports rather than grouped, which helps reduce merge conflicts.
If you are using IntelliJ IDEA, you can disable it by unchecking: `Preferences` -> `Code Style` -> `Scala` -> `Imports` -> `Merge imports with the same prefix into one statement`.
It's recommended to run `sbt +sortImports` to keep the *import*s sorted.
#### Java style
-Akka uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources.
+Pekko uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources.
PR validation includes checking that the Java sources are formatted and will fail if they are not.
#### Code discipline opt out
-In addition to formatting, the Akka build enforces code discipline through a set of compiler flags. While exploring ideas, the discipline may be more of a hindrance than a help. Therefore, it is possible to disable it by setting the system property `akka.no.discipline`
+In addition to formatting, the Pekko build enforces code discipline through a set of compiler flags. While exploring ideas, the discipline may be more of a hindrance than a help. Therefore, it is possible to disable it by setting the system property `akka.no.discipline`
Review Comment:
we have not changed any code here - so today, Pekko code uses akka sys property names - this should change after we change (or at same time) that we change the Pekko code
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020209389
##########
CONTRIBUTING.md:
##########
@@ -253,9 +246,8 @@ e.g. `allCluster`, `allTyped`.
Binary compatibility rules and guarantees are described in depth in the [Binary Compatibility Rules
](https://doc.akka.io/docs/akka/snapshot/common/binary-compatibility-rules.html) section of the documentation.
-Akka uses [MiMa](https://github.com/lightbend/mima) to
-validate the binary compatibility of incoming pull requests. If your PR fails due to binary compatibility issues, you may see
-an error like this:
+Pekko uses [MiMa](https://github.com/lightbend/mima) to validate the binary compatibility of incoming pull requests. If your
+PR fails due to binary compatibility issues, you may see an error like this:
```
[info] akka-stream: found 1 potential binary incompatibilities while checking against com.typesafe.akka:akka-stream_2.12:2.4.2 (filtered 222)
Review Comment:
I have left it as is for now.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018167107
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
@hen Do you suggest using "Apache Pekko" everywhere where "Pekko" is used? That might feel a little "non-smooth". I can start with "Apache Pekko" the first time, and then use Pekko the rest of the places. What do you think?
@pjfanning /others: any opinion on this?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020121966
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
-### Java APIs in Akka
+### Java APIs in Pekko
-Akka aims to keep 100% feature parity between Java and Scala. Implementing even the API for Java in
+Pekko aims to keep 100% feature parity between Java and Scala. Implementing even the API for Java in
Scala has proven the most viable way to do it, as long as you keep the following in mind:
1. Keep entry points separated in `javadsl` and `scaladsl` unless changing existing APIs which for historical
and binary compatibility reasons do not have this subdivision.
1. Have methods in the `javadsl` package delegate to the methods in the Scala API, or the common internal implementation.
- For example, the Akka Stream Scala instances have a `.asJava` method to convert to the `akka.stream.javadsl` counterparts.
+ For example, the Pekko Stream Scala instances have a `.asJava` method to convert to the `akka.stream.javadsl` counterparts.
Review Comment:
we have not made any code changes yet - the current code uses pekko package names
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020169889
##########
CONTRIBUTING.md:
##########
@@ -253,9 +246,8 @@ e.g. `allCluster`, `allTyped`.
Binary compatibility rules and guarantees are described in depth in the [Binary Compatibility Rules
](https://doc.akka.io/docs/akka/snapshot/common/binary-compatibility-rules.html) section of the documentation.
-Akka uses [MiMa](https://github.com/lightbend/mima) to
-validate the binary compatibility of incoming pull requests. If your PR fails due to binary compatibility issues, you may see
-an error like this:
+Pekko uses [MiMa](https://github.com/lightbend/mima) to validate the binary compatibility of incoming pull requests. If your
+PR fails due to binary compatibility issues, you may see an error like this:
```
[info] akka-stream: found 1 potential binary incompatibilities while checking against com.typesafe.akka:akka-stream_2.12:2.4.2 (filtered 222)
Review Comment:
That's a good point. @pjfanning : Should I then just keep it as-is with pekko:pekko-stream as eventually we will start doing this after the first release? Or should we remove for now and bring it back once a release is done. My vote is for the former, that is, keep it as-is with pekko:pekko-stream. Let me know.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020210478
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
Review Comment:
Done
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] spangaer commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1019420553
##########
CONTRIBUTING.md:
##########
@@ -6,11 +6,13 @@ We follow the standard GitHub [fork & pull](https://help.github.com/articles/usi
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
Review Comment:
@naosense : thanks, yes - missed that. In fact have missed a few more instances in this file, have fixed all of them. Please review.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020121531
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
Review Comment:
I agree - we should remove any links to akka.io and add the sections back when we have our own website - maybe, we could comment out these sections in the `.md` file to act as a reminder that the sections need to be revived
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020122306
##########
CONTRIBUTING.md:
##########
@@ -581,13 +570,13 @@ Scala has proven the most viable way to do it, as long as you keep the following
| `() => R` (`scala.Function0[R]`) | `java.util.function.Supplier<R>` |
| `T => R` (`scala.Function1[T, R]`) | `java.util.function.Function<T, R>` |
-### Contributing new Akka Streams operators
+### Contributing new Pekko Streams operators
-Documentation of Akka Streams operators is automatically enforced.
+Documentation of Pekko Streams operators is automatically enforced.
If a method exists on Source / Sink / Flow, or any other class listed in `project/StreamOperatorsIndexGenerator.scala`,
it must also have a corresponding documentation page under `akka-docs/src/main/paradox/streams/operators/...`.
-Akka Streams operators' consistency is enforced by `ConsistencySpec`, normally an operator should exist on both Source / SubSource, Flow / SubFlow, Sink / SubSink.
+Pekko Streams operators' consistency is enforced by `ConsistencySpec`, normally an operator should exist on both Source / SubSource, Flow / SubFlow, Sink / SubSink.
The pages structure is well-defined and must be the same on all documentation pages. Please refer to any neighbouring
docs pages in there to see the pattern in action. In general the page must consist of:
Review Comment:
akka-docs has not yet been renamed as pekko-docs
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] gmethvin commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
gmethvin commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017247555
##########
CONTRIBUTING.md:
##########
@@ -431,7 +421,7 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
### Pull request validation workflow details
-Akka uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
+Pekko uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
Review Comment:
nit: fix grammar, either of:
- `...which involves checking code style, running tests, checking binary compatibility, etc.`
- `...which checks code style, runs tests, checks binary compatibility, etc.`
##########
CONTRIBUTING.md:
##########
@@ -295,28 +288,25 @@ 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.
-
- Akka uses the first choice, having copyright notices in every file header. When absent, these are added automatically during `sbt compile`.
+1. Licensing rules:
+ - Existing files with copyright statements must leave those copyright statements intact
+ - New files should have an Apache license header instead
Review Comment:
probably should clarify what Apache license header means and link to an example, though this is probably something we should automate
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018176392
##########
CONTRIBUTING.md:
##########
@@ -431,7 +421,7 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
### Pull request validation workflow details
-Akka uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
+Pekko uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
Review Comment:
Done - please review.
##########
CONTRIBUTING.md:
##########
@@ -295,28 +288,25 @@ 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.
-
- Akka uses the first choice, having copyright notices in every file header. When absent, these are added automatically during `sbt compile`.
+1. Licensing rules:
+ - Existing files with copyright statements must leave those copyright statements intact
+ - New files should have an Apache license header instead
Review Comment:
Done - please review.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] Claudenw commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
Claudenw commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020062303
##########
CONTRIBUTING.md:
##########
@@ -253,9 +246,8 @@ e.g. `allCluster`, `allTyped`.
Binary compatibility rules and guarantees are described in depth in the [Binary Compatibility Rules
](https://doc.akka.io/docs/akka/snapshot/common/binary-compatibility-rules.html) section of the documentation.
-Akka uses [MiMa](https://github.com/lightbend/mima) to
-validate the binary compatibility of incoming pull requests. If your PR fails due to binary compatibility issues, you may see
-an error like this:
+Pekko uses [MiMa](https://github.com/lightbend/mima) to validate the binary compatibility of incoming pull requests. If your
+PR fails due to binary compatibility issues, you may see an error like this:
```
[info] akka-stream: found 1 potential binary incompatibilities while checking against com.typesafe.akka:akka-stream_2.12:2.4.2 (filtered 222)
Review Comment:
Would the text here be akka:akka-stream or pekko:pekko-stream? And below for akka-actor I have the same questions.
##########
CONTRIBUTING.md:
##########
@@ -68,18 +62,17 @@ We encourage changes that make it easier to achieve our goals efficiently.
The steps below describe how to get a patch into the main development branch (`main`).
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
-1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka/issues) and [existing pull requests](https://github.com/akka/akka/pulls) for existing work.
- - If there is no ticket yet, feel free to [create one](https://github.com/akka/akka/issues/new) to discuss the problem and the approach you want to take to solve it.
-1. [Fork the project](https://github.com/akka/akka#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
+1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko/issues) and [existing pull requests](https://github.com/apache/incubator-pekko/pulls) for existing work.
+ - If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko/issues/new) to discuss the problem and the approach you want to take to solve it.
+1. [Fork the project](https://github.com/apache/incubator-pekko#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
1. Create a branch on your fork and work on the feature. For example: `git checkout -b custom-headers-akka-http`
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
Review Comment:
We should not be adding, removing, or modifying copyright headers.
I think the phrase "and includes the proper copyright headers" should be removed.
In addition the sbt task should be checked to verify that it does not require copyright headers. It it does another ticket should be opened to fix that.
##########
CONTRIBUTING.md:
##########
@@ -581,13 +570,13 @@ Scala has proven the most viable way to do it, as long as you keep the following
| `() => R` (`scala.Function0[R]`) | `java.util.function.Supplier<R>` |
| `T => R` (`scala.Function1[T, R]`) | `java.util.function.Function<T, R>` |
-### Contributing new Akka Streams operators
+### Contributing new Pekko Streams operators
-Documentation of Akka Streams operators is automatically enforced.
+Documentation of Pekko Streams operators is automatically enforced.
If a method exists on Source / Sink / Flow, or any other class listed in `project/StreamOperatorsIndexGenerator.scala`,
it must also have a corresponding documentation page under `akka-docs/src/main/paradox/streams/operators/...`.
-Akka Streams operators' consistency is enforced by `ConsistencySpec`, normally an operator should exist on both Source / SubSource, Flow / SubFlow, Sink / SubSink.
+Pekko Streams operators' consistency is enforced by `ConsistencySpec`, normally an operator should exist on both Source / SubSource, Flow / SubFlow, Sink / SubSink.
The pages structure is well-defined and must be the same on all documentation pages. Please refer to any neighbouring
docs pages in there to see the pattern in action. In general the page must consist of:
Review Comment:
below here there is a reference to akka-docs should that be pekko-docs?
##########
CONTRIBUTING.md:
##########
@@ -630,6 +616,5 @@ Anyone can propose new changes to our CI workflows, and we will gladly review th
### Related links
-* [Akka Contributor License Agreement](https://www.lightbend.com/contribute/cla)
-* [Akka Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
+* [Pekko Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
Review Comment:
Should point to our issue tracking
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
Review Comment:
This should point to pekko docs. Also, the link specified is dead.
Since the link is dead and we don't have a website, remove the link and open a ticket to add the missing documentation to our documentation and to put a link back in this section when it exists.
##########
CONTRIBUTING.md:
##########
@@ -473,21 +462,21 @@ not needed to use `sbt scalafmtAll` when editing with IntelliJ.
PR validation includes checking that the Scala sources are formatted and will fail if they are not.
-Akka prefers flattened imports rather than grouped, which helps reduce merge conflicts.
+Pekko prefers flattened imports rather than grouped, which helps reduce merge conflicts.
If you are using IntelliJ IDEA, you can disable it by unchecking: `Preferences` -> `Code Style` -> `Scala` -> `Imports` -> `Merge imports with the same prefix into one statement`.
It's recommended to run `sbt +sortImports` to keep the *import*s sorted.
#### Java style
-Akka uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources.
+Pekko uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources.
PR validation includes checking that the Java sources are formatted and will fail if they are not.
#### Code discipline opt out
-In addition to formatting, the Akka build enforces code discipline through a set of compiler flags. While exploring ideas, the discipline may be more of a hindrance than a help. Therefore, it is possible to disable it by setting the system property `akka.no.discipline`
+In addition to formatting, the Pekko build enforces code discipline through a set of compiler flags. While exploring ideas, the discipline may be more of a hindrance than a help. Therefore, it is possible to disable it by setting the system property `akka.no.discipline`
Review Comment:
should akka.no.dicipline be changed to pekko.no.dicipline
##########
CONTRIBUTING.md:
##########
@@ -581,13 +570,13 @@ Scala has proven the most viable way to do it, as long as you keep the following
| `() => R` (`scala.Function0[R]`) | `java.util.function.Supplier<R>` |
Review Comment:
should akka.util.JavaDurationConverters be pekko.util.JavaDurationConverters ?
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
-### Java APIs in Akka
+### Java APIs in Pekko
-Akka aims to keep 100% feature parity between Java and Scala. Implementing even the API for Java in
+Pekko aims to keep 100% feature parity between Java and Scala. Implementing even the API for Java in
Scala has proven the most viable way to do it, as long as you keep the following in mind:
1. Keep entry points separated in `javadsl` and `scaladsl` unless changing existing APIs which for historical
and binary compatibility reasons do not have this subdivision.
1. Have methods in the `javadsl` package delegate to the methods in the Scala API, or the common internal implementation.
- For example, the Akka Stream Scala instances have a `.asJava` method to convert to the `akka.stream.javadsl` counterparts.
+ For example, the Pekko Stream Scala instances have a `.asJava` method to convert to the `akka.stream.javadsl` counterparts.
Review Comment:
Is it still to be akka.stream.javadsl or will it be pekko.stream.javadsl?
##########
RELEASING.md:
##########
@@ -50,9 +50,6 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
-Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
-
Review Comment:
You removed the sonatype information here but leave it below. Do not think that we are publishing to sonatype and, IMHO, no user should do that directly.
Also farther below there is a reference to akka-docs should that be pekko-docs?
##########
CONTRIBUTING.md:
##########
@@ -431,7 +420,7 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
### Pull request validation workflow details
-Akka uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
+Pekko uses GitHub Actions to validate pull requests, which involves checking code style, running tests, checking binary compatibility, etc.
For existing contributors, Github Actions will run without requiring any manual intervention from a core team member.
Review Comment:
Below there are akka-persistence and akka-remote notes. Do those need to be changed to pekko-persistence and pekko-remote?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] hen commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
hen commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020576972
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
+1. First use with the full name, then get more casual for the rest of a document.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#issuecomment-1313120765
Hello @pjfanning @Claudenw : I have not seen any new comment in last couple of days and the PR is ready. Can this be merged? Thanks!
@Claudenw : Can #28 be assigned to me?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017021089
##########
README.md:
##########
@@ -2,10 +2,10 @@ Apache Pekko
============
Apache Pekko is an open-source framework for building applications that are concurrent, distributed, resilient and elastic.
+Pekko uses the Actor Model to provide more intuitive high-level abstractions for concurrency.
+Using these abstractions, Pekko also provides libraries for persistence, streams, HTTP, and more.
Review Comment:
could you remove the stray comma after `HTTP`?
##########
CONTRIBUTING.md:
##########
@@ -613,14 +603,14 @@ existence of those docs.
### Reporting security issues
-If you have found an issue in an Akka project that might have security
-implications, you can report it to <se...@lightbend.com>. We will make
+If you have found an issue in an Pekko project that might have security
+implications, you can report it to <???>. We will make
Review Comment:
link to Security.md - https://github.com/apache/.github/blob/main/.github/SECURITY.md
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017830129
##########
CONTRIBUTING.md:
##########
@@ -295,28 +288,25 @@ 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.
-
- Akka uses the first choice, having copyright notices in every file header. When absent, these are added automatically during `sbt compile`.
+1. Licensing rules:
+ - Existing files with copyright statements must leave those copyright statements intact
+ - New files should have an Apache license header instead
Review Comment:
We could use this as an example: https://github.com/apache/poi/blob/trunk/poi/src/main/java/org/apache/poi/POIDocument.java
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020170532
##########
CONTRIBUTING.md:
##########
@@ -431,7 +420,7 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
### Pull request validation workflow details
-Akka uses GitHub Actions to validate pull requests, which involves checking code style, run tests, check binary compatibility, etc.
+Pekko uses GitHub Actions to validate pull requests, which involves checking code style, running tests, checking binary compatibility, etc.
For existing contributors, Github Actions will run without requiring any manual intervention from a core team member.
Review Comment:
@Claudenw : there is a separate effort going on to update all the folder names. I will create a new PR once that effort is done, since that would probably take some time.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020122908
##########
CONTRIBUTING.md:
##########
@@ -630,6 +616,5 @@ Anyone can propose new changes to our CI workflows, and we will gladly review th
### Related links
-* [Akka Contributor License Agreement](https://www.lightbend.com/contribute/cla)
-* [Akka Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
+* [Pekko Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
Review Comment:
I agree - the right link is https://github.com/apache/incubator-pekko/issues
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020175963
##########
CONTRIBUTING.md:
##########
@@ -509,28 +498,28 @@ There are a number of ways timeouts can be defined in Akka tests. The following
Special care should be given to `expectNoMessage` calls, which indeed will wait for the entire timeout before continuing. Therefore a shorter timeout should be used in those, for example `200.millis` or `300.millis`. Prefer the method without timeout parameter, which will use the configured `expect-no-message-default` timeout.
-You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
+You can read up on `remaining` and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
### Contributing modules
For external contributions of entire features, the normal way is to establish it
as a stand-alone project first, to show that there is a need for the feature. If there is enough interested, the
-next step would be to add it to Akka as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
+next step would be to add it to Pekko as an "may change"-feature (possibly in a new subproject) and marking it's public api with the `ApiMayChange` annotation,
then when the feature is hardened, well documented and
-tested it becomes an officially supported Akka feature.
+tested it becomes an officially supported Pekko feature.
-[List of Akka features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
+[List of Pekko features marked as may change](https://doc.akka.io/docs/akka/current/common/may-change.html)
Review Comment:
Ok - I will replace all akka.io links with [pekko.apache.org/](https://pekko.apache.org/). Although that is not operational yet, hopefully it will be soon.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020123369
##########
RELEASING.md:
##########
@@ -50,9 +50,6 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
-Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
-
Review Comment:
We don't publish any snapshots yet - so claiming we do is incorrect
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020208614
##########
CONTRIBUTING.md:
##########
@@ -68,18 +62,17 @@ We encourage changes that make it easier to achieve our goals efficiently.
The steps below describe how to get a patch into the main development branch (`main`).
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
-1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka/issues) and [existing pull requests](https://github.com/akka/akka/pulls) for existing work.
- - If there is no ticket yet, feel free to [create one](https://github.com/akka/akka/issues/new) to discuss the problem and the approach you want to take to solve it.
-1. [Fork the project](https://github.com/akka/akka#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
+1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko/issues) and [existing pull requests](https://github.com/apache/incubator-pekko/pulls) for existing work.
+ - If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko/issues/new) to discuss the problem and the approach you want to take to solve it.
+1. [Fork the project](https://github.com/apache/incubator-pekko#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline Akka.
1. Create a branch on your fork and work on the feature. For example: `git checkout -b custom-headers-akka-http`
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
Review Comment:
Understand your comment. However, what copyright information would finally be adopted would depend on discussions with legal, which is ongoing. We can always update/finetune later. I would just retain this for now - hope this is alright.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020203350
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
Done as mentioned above.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1016623146
##########
RELEASING.md:
##########
@@ -51,7 +51,7 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
+https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/pekko/
Review Comment:
can you remove this section about snapshots? - we can replace it when we have nightly builds
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#issuecomment-1307260690
There was an existing PR that was approved and is now merged - https://github.com/apache/incubator-pekko/pull/33.
It is worth checking to see what other issues and PRs are open before proceeding with new PRs.
Could you rebase your changes and look at PR comments?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1016902904
##########
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:
Added.
##########
RELEASING.md:
##########
@@ -51,7 +51,7 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
+https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/pekko/
Review Comment:
Done
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018176736
##########
CONTRIBUTING.md:
##########
@@ -613,14 +603,14 @@ existence of those docs.
### Reporting security issues
-If you have found an issue in an Akka project that might have security
-implications, you can report it to <se...@lightbend.com>. We will make
+If you have found an issue in an Pekko project that might have security
+implications, you can report it to <???>. We will make
Review Comment:
Done - please review.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] naosense commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
naosense commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018620506
##########
CONTRIBUTING.md:
##########
@@ -6,11 +6,13 @@ We follow the standard GitHub [fork & pull](https://help.github.com/articles/usi
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
Review Comment:
> contributing to Akka as smooth
is this just a oversight?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] naosense commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
naosense commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018620506
##########
CONTRIBUTING.md:
##########
@@ -6,11 +6,13 @@ We follow the standard GitHub [fork & pull](https://help.github.com/articles/usi
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
Review Comment:
> contributing to Akka as smooth
is this just an oversight?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020118999
##########
CONTRIBUTING.md:
##########
@@ -253,9 +246,8 @@ e.g. `allCluster`, `allTyped`.
Binary compatibility rules and guarantees are described in depth in the [Binary Compatibility Rules
](https://doc.akka.io/docs/akka/snapshot/common/binary-compatibility-rules.html) section of the documentation.
-Akka uses [MiMa](https://github.com/lightbend/mima) to
-validate the binary compatibility of incoming pull requests. If your PR fails due to binary compatibility issues, you may see
-an error like this:
+Pekko uses [MiMa](https://github.com/lightbend/mima) to validate the binary compatibility of incoming pull requests. If your
+PR fails due to binary compatibility issues, you may see an error like this:
```
[info] akka-stream: found 1 potential binary incompatibilities while checking against com.typesafe.akka:akka-stream_2.12:2.4.2 (filtered 222)
Review Comment:
we will not be doing mima checks until after we do a release - the mima checks prove that you have broken bin compatibility with a previous release - we have no releases to compare against. we can't compare to akka because we are changing package names, jar names and other things like that are not binary compatible
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#issuecomment-1307267997
@samikrc I hope you don't mind but I resolved the merge conflicts myself. Would you be still able to make the rest of the requested changes?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#issuecomment-1307545695
Hi @pjfanning : thanks for the review. I have incorporated all the comments. Please review.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] hen commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
hen commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017392943
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
Reminder to lean to 'Apache Pekko' name wise.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] gmethvin commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
gmethvin commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018441245
##########
CONTRIBUTING.md:
##########
@@ -1,10 +1,10 @@
-# Welcome! Thank you for interest in contributing to Akka!
+# Welcome! Thank you for interest in contributing to Pekko!
We follow the standard GitHub [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
-## The Akka Community
+## The Pekko Community
If you have questions about the contribution process or discuss specific issues, please visit the [akka/dev Gitter chat](https://gitter.im/akka/dev).
Review Comment:
I believe the convention would be to use "Apache Pekko" initially, then use "Pekko" thereafter. I don't think it makes sense to use "Apache Pekko" everywhere, but it might make sense to use either on section headings or on the first usage of Pekko in the section, since someone might start reading the document 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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017070008
##########
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:
my response is based on https://lists.apache.org/thread/z0r4sr4kdvmh52mlhc5porot2sh1wtok
there will be a need to have 2 copyrights in some files but it won't happen yet - the plan for next few months is minimal changes - we can agree what the 2 copyright header looks like - but it is not urgent - the 2 copyright header could be as simple as having the existing Lightbend license and then the Apache license after it
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] spangaer commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
spangaer commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017067895
##########
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:
Note I had launched a thread on this exact subject on dev list
https://lists.apache.org/thread/xpc7yxdctkflntzvlxc9kw2yjbcth4n0
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] gmethvin commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
gmethvin commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017077326
##########
README.md:
##########
@@ -2,10 +2,10 @@ Apache Pekko
============
Apache Pekko is an open-source framework for building applications that are concurrent, distributed, resilient and elastic.
+Pekko uses the Actor Model to provide more intuitive high-level abstractions for concurrency.
+Using these abstractions, Pekko also provides libraries for persistence, streams, HTTP, and more.
Review Comment:
We're just nitpicking here, but to me a serial comma seems more natural before "and more". I see it as basically the same as "etc.", where the prevalent style is to use a comma before.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] hen commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
hen commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1017395400
##########
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:
If you open up an issue on the Legal JIRA, we can come up with a combined text there. Mixing the Akka header with the ASF one might mean some creativity. I also see that a lot of Akka headers seem to just be the Lightbend copyright statement; which again probably means some creativity.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018168375
##########
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:
Will keep to the current text (as suggested by @pjfanning ) for now then. Can always update once we have more clarity.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] naosense commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
naosense commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1018620506
##########
CONTRIBUTING.md:
##########
@@ -6,11 +6,13 @@ We follow the standard GitHub [fork & pull](https://help.github.com/articles/usi
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc or the README.md). The goal of these notes is to make your experience contributing to Akka as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
Review Comment:
> contributing to Akka as smooth
is this just a oversight?
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020228203
##########
RELEASING.md:
##########
@@ -50,9 +50,6 @@ scaladoc generation build task, which is part of the release.
## Snapshot releases
-Snapshot releases are created from `main` and published to
-https://oss.sonatype.org/content/repositories/snapshots/com/typesafe/akka/
-
Review Comment:
I think this change is fine as is - we have details of how to create a local snapshot and the user should never publish to sonatype. I'm happy to resolve this part of the conversation.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] pjfanning commented on pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
pjfanning commented on PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#issuecomment-1315000865
thanks @samikrc - I'll merge as is - it is good to lower the Akka specific references in the docs - any remaining issues can be resolved in new PRs
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] samikrc commented on a diff in pull request #36: Updated references from akka to pekko #28
Posted by GitBox <gi...@apache.org>.
samikrc commented on code in PR #36:
URL: https://github.com/apache/incubator-pekko/pull/36#discussion_r1020210718
##########
CONTRIBUTING.md:
##########
@@ -630,6 +616,5 @@ Anyone can propose new changes to our CI workflows, and we will gladly review th
### Related links
-* [Akka Contributor License Agreement](https://www.lightbend.com/contribute/cla)
-* [Akka Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
+* [Pekko Issue Tracker](https://doc.akka.io/docs/akka/current/project/issue-tracking.html)
Review Comment:
Good catch - thanks. Done.
--
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-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org