From 5fc55ac82cb52db7ad626da2aecdb3eb3b23e964 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Fri, 2 Feb 2018 12:15:41 +0100 Subject: [PATCH] Document preference of 'internal' package (#24481) Over `impl` which we also use here and there. We could rename `impl` packages, but should be careful to check we're not (accidentally?) using them in other modules. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1703e6abe2..625e42dc2d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -334,6 +334,9 @@ Note, that `OK TO TEST` will only be picked up when the user asking for it is co ## Source style +Sometimes it is convenient to place 'internal' classes in their own package. +In such situations we prefer 'internal' over 'impl' as a package name. + ### Scala style Akka uses [Scalariform](https://github.com/daniel-trinh/scalariform) to enforce some of the code style rules.