From a97bdda6e82cd142dd3532bcaee2e0d3dedaba4b Mon Sep 17 00:00:00 2001 From: Viktor Klang Date: Mon, 2 May 2011 18:38:21 +0200 Subject: [PATCH] Converting the Akka Developer Guidelines and add then to the General section --- .../{pending => general}/developer-guidelines.rst | 12 ++++++------ akka-docs/general/index.rst | 1 + 2 files changed, 7 insertions(+), 6 deletions(-) rename akka-docs/{pending => general}/developer-guidelines.rst (64%) diff --git a/akka-docs/pending/developer-guidelines.rst b/akka-docs/general/developer-guidelines.rst similarity index 64% rename from akka-docs/pending/developer-guidelines.rst rename to akka-docs/general/developer-guidelines.rst index bf2e9dad26..5965a2fe41 100644 --- a/akka-docs/pending/developer-guidelines.rst +++ b/akka-docs/general/developer-guidelines.rst @@ -1,4 +1,4 @@ -Developer Guidelines +Developer Guidelines (committers) ==================== Code Style @@ -6,25 +6,25 @@ Code Style The Akka code style follows `this document `_ . -Here is a code style settings file for IntelliJ IDEA. -``_ +Here is a code style settings file for ``IntelliJ IDEA``: +`Download <@http://scalablesolutions.se/akka/docs/akka-0.10/files/akka-intellij-code-style.jar>`_ Please follow the code style. Look at the code around you and mimic. Testing ------- -All code that is checked in should have tests. All testing is done with ScalaTest and ScalaCheck. +All code that is checked in **should** have tests. All testing is done with ``ScalaTest`` and ``ScalaCheck``. * Name tests as *Test.scala if they do not depend on any external stuff. That keeps surefire happy. * Name tests as *Spec.scala if they have external dependencies. -There is a testing standard that should be followed: `Ticket001Spec <@https://github.com/jboner/akka/blob/master/akka-actor/src/test/scala/akka/ticket/Ticket001Spec.scala>`_ +There is a testing standard that should be followed: `Ticket001Spec <@https://github.com/jboner/akka/blob/master/akka-actor-tests/src/test/scala/akka/ticket/Ticket001Spec.scala>`_ Actor TestKit ^^^^^^^^^^^^^ -There is a useful test kit for testing actors: `akka.util.TestKit <@https://github.com/jboner/akka/tree/master/akka-actor/src/main/scala/akka/util/TestKit.scala>`_. It enables assertions concerning replies received and their timing, there is more documentation in the ``_ module. +There is a useful test kit for testing actors: `akka.util.TestKit <@https://github.com/jboner/akka/tree/master/akka-testkit/src/main/scala/akka/testkit/TestKit.scala>`_. It enables assertions concerning replies received and their timing, there is more documentation in the ``_ module. NetworkFailureTest ^^^^^^^^^^^^^^^^^^ diff --git a/akka-docs/general/index.rst b/akka-docs/general/index.rst index 6eae15cf67..f836c00d1c 100644 --- a/akka-docs/general/index.rst +++ b/akka-docs/general/index.rst @@ -10,3 +10,4 @@ General configuration event-handler util + developer-guidelines