You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by nv...@apache.org on 2023/01/16 12:25:10 UTC
[incubator-pekko-management] branch main updated: Updates license, notice, readme and contributing (#7)
This is an automated email from the ASF dual-hosted git repository.
nvollmar pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-management.git
The following commit(s) were added to refs/heads/main by this push:
new 78765f0 Updates license, notice, readme and contributing (#7)
78765f0 is described below
commit 78765f0851f1560b96b1f67df62208978b706ca4
Author: Nicolas Vollmar <nv...@gmail.com>
AuthorDate: Mon Jan 16 13:25:04 2023 +0100
Updates license, notice, readme and contributing (#7)
---
CONTRIBUTING.md | 24 ++++++++++++------------
LICENSE | 3 ---
NOTICE | 11 +++++++++++
README.md | 50 +++++++++++++++++++++++++++++++++++---------------
4 files changed, 58 insertions(+), 30 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 96e3c78..21fae2f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,28 +1,28 @@
-# Welcome! Thank you for contributing to Akka Cluster Management!
+# Contributing to the Apache Pekko Management
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 Management as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your 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 Apache Pekko 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
-In case of questions about the contribution process or for discussion of specific issues please visit the [akka/dev gitter chat](https://gitter.im/akka/dev).
+If you have questions about the contribution process or discuss specific issues, please interact with the community using the following resources.
-You may also check out these [other resources](https://akka.io/get-involved/).
+- [GitHub discussions](https://github.com/apache/incubator-pekko-management/discussions): for questions and general discussion.
+- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
+- [GitHub issues](https://github.com/apache/incubator-pekko-management/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
## General Workflow
This is the process for committing code into master.
-1. Make sure you have signed the Lightbend CLA, if not, [sign it online](https://www.lightbend.com/contribute/cla).
-2. Especially for bigger features it can be good to create or find a ticket for your work in the [issue tracker](https://github.com/akka/akka-management/issues) and discuss your proposed solution there. This is not a requirement, but can avoid disappointment later in the process.
+1. Sign the [CLA](https://www.apache.org/licenses/contributor-agreements.html) if necessary.
+2. Especially for bigger features it can be good to create or find a ticket for your work in the [issue tracker](https://github.com/apache/incubator-pekko-management/issues) and discuss your proposed solution there. This is not a requirement, but can avoid disappointment later in the process.
3. Perform your work according to the [pull request requirements](#pull-request-requirements).
-4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on [GitHub](https://github.com/akka/akka-management/pulls).
+4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on [GitHub](https://github.com/apache/incubator-pekko-management/pulls).
5. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Note that the maintainers can consist of outside contributors, both within and outside Lightbend. Outside contributors are encouraged to participate in the review process, it is not a closed process.
6. After the review you should fix the issues (review comments, CI failures) by pushing a new commit for new review, iterating until the reviewers give their thumbs up and CI tests pass.
-In case of questions about the contribution process or for discussion of specific issues please visit the [akka/dev gitter chat](https://gitter.im/akka/dev).
-
## Pull Request Requirements
For a Pull Request to be considered at all it has to meet these requirements:
@@ -43,7 +43,7 @@ If these requirements are not met then the code should **not** be merged into ma
Documentation should be written in two forms:
1. API documentation in the form of scaladoc/javadoc comments on the Scala and Java user API.
-2. Guide documentation in [docs](docs/) subproject using [Paradox](https://github.com/lightbend/paradox) documentation tool. This documentation should give a short introduction of how a given connector should be used.
+2. Guide documentation in [docs](docs/) subproject using [Paradox](https://github.com/apache/incubator-pekko-sbt-paradox) documentation tool. This documentation should give a short introduction of how a given connector should be used.
## External Dependencies
@@ -88,6 +88,6 @@ Example:
## How To Enforce These Guidelines?
-1. [Travis CI](https://travis-ci.org/akka/akka-management) automatically merges the code, builds it, runs the tests and sets Pull Request status accordingly of results in GitHub.
+1. [CI](https://github.com/apache/incubator-pekko-management/actions) automatically merges the code, builds it, runs the tests and sets Pull Request status accordingly of results in GitHub.
2. [Scalafmt](https://olafurpg.github.io/scalafmt) enforces some of the code style rules.
3. [sbt-header plugin](https://github.com/sbt/sbt-header) manages consistent copyright headers in every source file.
diff --git a/LICENSE b/LICENSE
index 345e2ad..4a67574 100644
--- a/LICENSE
+++ b/LICENSE
@@ -200,7 +200,4 @@
See the License for the specific language governing permissions and
limitations under the License.
----------------
-Licenses for dependency projects can be found here:
-[http://akka.io/docs/akka/snapshot/project/licenses.html]
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..0c1032e
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,11 @@
+Apache Pekko Management
+Copyright 2022, 2023 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
+
+This product contains significant parts that were originally based on software from Lightbend (Akka <https://akka.io/>).
+Copyright (C) 2009-2022 Lightbend Inc. <https://www.lightbend.com>
+
+Apache Pekko Management is derived from Akka Management 1.1.x, the last version that was distributed under the
+Apache License, Version 2.0 License.
diff --git a/README.md b/README.md
index 5ccaa21..0218980 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,57 @@
-# Akka (Cluster) Management
+# Apache Pekko (Cluster) Management
+
+This repository contains interfaces to inspect, interact and manage various Parts of Apache Pekko, primarily Pekko Cluster.
+Future additions may extend these concepts to other parts of Apache Pekko.
+
+Apache Pekko Management is a fork of [Akka Management](https://github.com/akka/akka-management)
+
-This repository contains interfaces to inspect, interact and manage various Parts of Akka, primarily Akka Cluster.
-Future additions may extend these concepts to other parts of Akka.
Documentation
-------------
-See [reference](https://doc.akka.io/docs/akka-management/current/) and [API](https://doc.akka.io/api/akka-management/current/akka/management/index.html)
+**TODO add documentation links**
+
+Community
+---------
+
+There are several ways to interact with the Apache Pekko community:
+
+- [GitHub discussions](https://github.com/apache/incubator-pekko-management/discussions): for questions and general discussion.
+- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
+- [GitHub issues](https://github.com/apache/incubator-pekko-management/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
Contributions & Maintainers
---------------------------
-*This project does not have contributors, it only has maintainers—frequent and infrequent—and everyone helps out.*
-We love new maintainers as well as old maintainers. :-)
-The Akka core team keeps an eye on the project to assure its overall coherence but does not fully support these modules.
+Contributions are very welcome. If you have an idea on how to improve Apache Pekko Management, don't hesitate to create an issue or submit a pull request.
-Contributions are very welcome, see [CONTRIBUTING.md](https://github.com/akka/akka-management/blob/master/CONTRIBUTING.md) or skim [existing tickets](https://github.com/akka/akka-management/issues) to see where you could help out.
+See [CONTRIBUTING.md](https://github.com/apache/incubator-pekko-management/blob/main/CONTRIBUTING.md) for details on the development workflow and how to create your pull request.
Project Status
--------------
With the exception of the community maintained modules listed below version 1.0.0 or later of this library
-is ready to be used in production, APIs are stable, and the Lightbend subscription covers support for these modules.
+is ready to be used in production and APIs are stable.
The following modules are maintained by the community and does not have to obey the rule of staying binary compatible
between releases. Breaking API changes may be introduced without notice as we refine and simplify based on feedback.
-A module may be dropped in any release without prior deprecation. The Lightbend subscription does not cover support
-for the following modules.
+A module may be dropped in any release without prior deprecation.
+
+* pekko-discovery-marathon-api
+* pekko-discovery-aws-api
+* pekko-discovery-aws-api-async
+* pekko-discovery-consul
+
+Code of Conduct
+---------------
+
+Apache Pekko Management is governed by the [Apache code of conduct](https://www.apache.org/foundation/policies/conduct.html). By participating in this project you agree to abide by its terms.
+
+License
+-------
-* akka-discovery-marathon-api
-* akka-discovery-aws-api
-* akka-discovery-aws-api-async
-* akka-discovery-consul
+Apache Pekko Management is available under the Apache License, version 2.0. See [LICENSE](https://github.com/apache/incubator-pekko-management/blob/main/LICENSE) file for details.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org