This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 88c2e99abf Update CONTRIBUTING.md with branch and license details
(#2761)
88c2e99abf is described below
commit 88c2e99abf15c32bcbb654a8a9512a5cd4797f36
Author: PJ Fanning <[email protected]>
AuthorDate: Thu Mar 19 13:11:03 2026 +0100
Update CONTRIBUTING.md with branch and license details (#2761)
* Update CONTRIBUTING.md with branch and license details
* Update licensing rules in CONTRIBUTING.md
Clarify licensing rules for new files and copied code.
* Revise branch details in CONTRIBUTING.md
Updated maintenance branch information for Pekko.
---
CONTRIBUTING.md | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fef6f7dcf5..b2c6e33542 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,11 +14,13 @@ If you have questions about the contribution process or
discuss specific issues,
Depending on which version (or sometimes module) you want to work on, you
should target a specific branch as explained below:
-* `main` – active development branch of Pekko
+* `main` – active development branch of Pekko (2.0.x)
* `1.0.x` – maintenance branch of Pekko 1.0
* `1.1.x` – maintenance branch of Pekko 1.1
* `1.2.x` – maintenance branch of Pekko 1.2
-* `1.3.x` – maintenance branch of Pekko 1.3 (unreleased but active development
ongoing)
+* there are other `1.N.x` branches for newer minor versions of Pekko
+
+Generally, PRs should start on the `main` branch and we can choose to backport
them once merged there.
### Tags
@@ -290,7 +292,10 @@ For a pull request to be considered at all, it has to meet
these requirements:
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. Licensing rules:
- Existing files with copyright statements must leave those copyright
statements intact
- - New files should have an Apache license header instead. For an example of
this, see [this
file](https://github.com/apache/spark/blob/master/core/src/main/scala/org/apache/spark/SparkContext.scala).
+ - If you create a new file but copy in code from other files then you must
add the source headers from those original files. If in doubt, leave a comment
in your PR and explain where you took the code from. If the copied source comes
from an external project, we will need to know about this so that we can decide
if the code has an incompatible license and if it's ok, we will still need to
mention it in our LICENSE file.
+ - New files that have new code should have a standard Apache license header
instead. For an example of this, see [this
file](https://github.com/apache/spark/blob/master/core/src/main/scala/org/apache/spark/SparkContext.scala).
Do not put the special Pekko license header that mentions Akka in it on the
file unless you are copying code from an existing file that contains Akka
derived code.
+ - `sbt headerCreate` adds headers to new files - but the command does not
know about the origin of the code in the new files
+ - `sbt headerCheck` runs a check to see if files are missing headers
#### Additional guidelines
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
