You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- see [all tags here](https://github.com/akka/akka-core/labels)
37
37
38
38
In general *all issues are open for anyone working on them*. However, if you're new to the project and looking for an issue
39
39
that will be accepted and likely is a nice one to get started you should check out the following tags:
40
40
41
-
-[good first issue](https://github.com/akka/akka/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) - which identifies simple entry-level tickets, such as improvements of documentation or tests. If you're not sure how to solve a ticket but would like to work on it, feel free to ask in the issue about clarification or tips.
42
-
-[help wanted](https://github.com/akka/akka/labels/help%20wanted) - identifies issues that the core team will likely not have time to work on or that are nice entry-level tickets. If you're not sure how to solve a ticket but would like to work on it, feel free to ask in the issue about clarification or tips.
43
-
-[nice-to-have (low-priority)](https://github.com/akka/akka/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense but are not a very high priority (in the face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!
41
+
-[good first issue](https://github.com/akka/akka-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) - which identifies simple entry-level tickets, such as improvements of documentation or tests. If you're not sure how to solve a ticket but would like to work on it, feel free to ask in the issue about clarification or tips.
42
+
-[help wanted](https://github.com/akka/akka-core/labels/help%20wanted) - identifies issues that the core team will likely not have time to work on or that are nice entry-level tickets. If you're not sure how to solve a ticket but would like to work on it, feel free to ask in the issue about clarification or tips.
43
+
-[nice-to-have (low-priority)](https://github.com/akka/akka-core/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense but are not a very high priority (in the face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!
44
44
45
45
Another group of issues is those which start from a number. They're used to signal in what phase of development an issue is:
46
46
47
-
-[0 - new](https://github.com/akka/akka/labels/0%20-%20new) - is assigned when an issue is unclear on its purpose or if it is valid or not. Sometimes the additional tag `discuss` is used if they propose large-scale changes and need more discussion before moving into triaged (or being closed as invalid).
48
-
-[1 - triaged](https://github.com/akka/akka/labels/1%20-%20triaged) - roughly speaking means "this issue makes sense". Triaged issues are safe to pick up for contributing in terms of the likeliness of a patch for it being accepted. It is not recommended to start working on an issue that is not triaged.
49
-
-[2 - pick next](https://github.com/akka/akka/labels/2%20-%20pick%20next) - used to mark issues that are next up in the queue to be worked on. Sometimes it's also used to mark which PRs are expected to be reviewed/merged for the next release. The tag is non-binding and mostly used as an organisational helper.
50
-
-[3 - in progress](https://github.com/akka/akka/labels/3%20-%20in%20progress) - means someone is working on this ticket. If you see an issue that has the tag but seems inactive, it could have been an omission with removing the tag. Feel free to ping the ticket then if it's still being worked on.
47
+
-[0 - new](https://github.com/akka/akka-core/labels/0%20-%20new) - is assigned when an issue is unclear on its purpose or if it is valid or not. Sometimes the additional tag `discuss` is used if they propose large-scale changes and need more discussion before moving into triaged (or being closed as invalid).
48
+
-[1 - triaged](https://github.com/akka/akka-core/labels/1%20-%20triaged) - roughly speaking means "this issue makes sense". Triaged issues are safe to pick up for contributing in terms of the likeliness of a patch for it being accepted. It is not recommended to start working on an issue that is not triaged.
49
+
-[2 - pick next](https://github.com/akka/akka-core/labels/2%20-%20pick%20next) - used to mark issues that are next up in the queue to be worked on. Sometimes it's also used to mark which PRs are expected to be reviewed/merged for the next release. The tag is non-binding and mostly used as an organisational helper.
50
+
-[3 - in progress](https://github.com/akka/akka-core/labels/3%20-%20in%20progress) - means someone is working on this ticket. If you see an issue that has the tag but seems inactive, it could have been an omission with removing the tag. Feel free to ping the ticket then if it's still being worked on.
51
51
52
52
The last group of special tags indicates specific states a ticket is in:
53
53
54
-
-[bug](https://github.com/akka/akka/labels/bug) indicates potential production issues. Bugs take priority in being fixed above features. The core team dedicates some days to work on bugs in each sprint. Bugs which have reproducers are also great for community contributions as they're well-isolated. Sometimes we're not as lucky to have reproducers, though, then a bugfix should also include a test reproducing the original error along with the fix.
55
-
-[failed](https://github.com/akka/akka/labels/failed) indicates a CI failure (for example, from a nightly build). These tickets usually include a stacktrace + link to the failed job, and we'll add a comment when we see the same problem again. Since these tickets can either indicate tests with incorrect assumptions, or legitimate issues in the production code, we look at them periodically. When the same problem isn't seen again over a period of 6 months we assume it to be a rare flaky test or a problem that might have since been fixed, so we close the issue until it pops up again.
54
+
-[bug](https://github.com/akka/akka-core/labels/bug) indicates potential production issues. Bugs take priority in being fixed above features. The core team dedicates some days to work on bugs in each sprint. Bugs which have reproducers are also great for community contributions as they're well-isolated. Sometimes we're not as lucky to have reproducers, though, then a bugfix should also include a test reproducing the original error along with the fix.
55
+
-[failed](https://github.com/akka/akka-core/labels/failed) indicates a CI failure (for example, from a nightly build). These tickets usually include a stacktrace + link to the failed job, and we'll add a comment when we see the same problem again. Since these tickets can either indicate tests with incorrect assumptions, or legitimate issues in the production code, we look at them periodically. When the same problem isn't seen again over a period of 6 months we assume it to be a rare flaky test or a problem that might have since been fixed, so we close the issue until it pops up again.
These guidelines apply to all Akka projects, by which we mean both the `akka/akka` repository,
63
+
These guidelines apply to all Akka projects, by which we mean both the `akka/akka-core` repository,
64
64
as well as any plugins or additional repositories located under the Akka GitHub organisation.
65
65
66
66
These guidelines are meant to be a living document that should be changed and adapted as needed.
@@ -71,15 +71,15 @@ We encourage changes that make it easier to achieve our goals efficiently.
71
71
The steps below describe how to get a patch into the main development branch (`main`).
72
72
The steps are exactly the same for everyone involved in the project, including the core team and first-time contributors.
73
73
74
-
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.
75
-
- 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.
76
-
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.
74
+
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/akka/akka-core/issues) and [existing pull requests](https://github.com/akka/akka-core/pulls) for existing work.
75
+
- If there is no ticket yet, feel free to [create one](https://github.com/akka/akka-core/issues/new) to discuss the problem and the approach you want to take to solve it.
76
+
1.[Fork the project](https://github.com/akka/akka-core#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.
77
77
1. Create a branch on your fork and work on the feature. For example: `git checkout -b custom-headers-akka-http`
78
78
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
79
79
- 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.
80
80
- Use the `verifyCodeStyle` sbt task to ensure your code is properly formatted and includes the proper copyright headers.
81
81
1. Once your feature is complete, prepare the commit following our [Creating Commits And Writing Commit Messages](#creating-commits-and-writing-commit-messages). For example, a good commit message would be: `feat: Adding compression support for Manifests #22222` (note the reference to the ticket it aimed to resolve).
82
-
1. If it's a new feature or a change of behavior, document it on the [akka-docs](https://github.com/akka/akka/tree/main/akka-docs). When the feature touches Scala and Java DSL, document both the Scala and Java APIs.
82
+
1. If it's a new feature or a change of behavior, document it on the [akka-docs](https://github.com/akka/akka-core/tree/main/akka-docs). When the feature touches Scala and Java DSL, document both the Scala and Java APIs.
83
83
1. Now it's finally time to [submit the pull request](https://help.github.com/articles/using-pull-requests)!
84
84
- Please make sure to include a reference to the issue you're solving *in the comment* for the Pull Request, as this will cause the PR to be linked properly with the issue. Examples of good phrases for this are: "Resolves #1234" or "Refs #1234".
85
85
1. If you have not already done so, you will be asked by our CLA bot to [sign the Lightbend CLA](https://www.lightbend.com/contribute/cla/akka) online. CLA stands for Contributor License Agreement and protects intellectual property disputes from harming the project.
@@ -102,7 +102,7 @@ The TL;DR; of the above very precise workflow version is:
102
102
6. Keep polishing it until getting the required number of approvals
103
103
7. Profit!
104
104
105
-
> **Note:** Github Actions runs all the workflows for the forked project. We have filters to ensure that each action efectively runs only for the `akka/akka` repository, but you may also want to [disable Github Actions](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository) entirely in your fork.
105
+
> **Note:** Github Actions runs all the workflows for the forked project. We have filters to ensure that each action efectively runs only for the `akka/akka-core` repository, but you may also want to [disable Github Actions](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository) entirely in your fork.
106
106
107
107
#### Backporting
108
108
@@ -295,7 +295,7 @@ run `protobufGenerate`. The generated files are put in each project's `src/main/
295
295
The generated files are automatically transformed to use the shaded version of protobuf.
296
296
297
297
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
298
-
[Protobuf.scala](https://github.com/akka/akka/blob/main/project/Protobuf.scala) for details of how to override
298
+
[Protobuf.scala](https://github.com/akka/akka-core/blob/main/project/Protobuf.scala) for details of how to override
299
299
the settings for generation.
300
300
301
301
### Pull request requirements
@@ -489,7 +489,7 @@ There are a number of ways timeouts can be defined in Akka tests. The following
489
489
490
490
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.
491
491
492
-
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).
492
+
You can read up on `remaining` and friends in [TestKit.scala](https://github.com/akka/akka-core/blob/main/akka-testkit/src/main/scala/akka/testkit/TestKit.scala).
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,12 +40,12 @@ Akka actors also provide the abstraction for transparent distribution and the ba
40
40
Reference Documentation
41
41
-----------------------
42
42
43
-
The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka core libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka/releases) page.
43
+
The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka core libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka-core/releases) page.
44
44
45
45
The reference documentation for all Akka libraries is available via [doc.akka.io/libraries/](https://doc.akka.io/libraries/), details for the Akka core libraries
46
46
for [Scala](https://doc.akka.io/libraries/akka-core/current/?language=scala) and [Java](https://doc.akka.io/libraries/akka-core/current/?language=java).
47
47
48
-
The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka core libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka/releases) page.
48
+
The current versions of all Akka libraries are listed on the [Akka Dependencies](https://doc.akka.io/libraries/akka-dependencies/current/) page. Releases of the Akka core libraries in this repository are listed on the [GitHub releases](https://github.com/akka/akka-core/releases) page.
49
49
50
50
Contributing
51
51
------------
@@ -56,7 +56,7 @@ the best way to make it happen is to help out by submitting a pull request imple
56
56
We welcome contributions from all, even you are not yet familiar with this project,
57
57
We are happy to get you started, and will guide you through the process once you've submitted your PR.
58
58
59
-
Refer to the [CONTRIBUTING.md](https://github.com/akka/akka/blob/main/CONTRIBUTING.md) file for more details about the workflow,
59
+
Refer to the [CONTRIBUTING.md](https://github.com/akka/akka-core/blob/main/CONTRIBUTING.md) file for more details about the workflow,
60
60
and general hints on how to prepare your pull request. You can also ask for clarifications or guidance in GitHub issues directly,
61
61
or in the akka/dev chat if a more real time communication would be of benefit.
0 commit comments