raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

=doc Link to CONTRIBUTING.md and remove obsolete dev guidelines

Browse source 
(cherry picked from commit 84382f06494e908a2fa5e1ab452ba0fe770ba239)
This commit is contained in:
Patrik Nordwall 2014-10-02 08:23:38 +02:00
parent 9e915d73bb
commit 35cf4da860
1 changed files with 8 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

26
akka-docs/rst/dev/developer-guidelines.rst
View file

@ -5,7 +5,7 @@ Developer Guidelines
.. note:: .. note::
First read `The Akka Contributor Guidelines <https://github.com/akka/akka/blob/master/CONTRIBUTING.md>`_ . First read `The Akka Contributor Guidelines`_.
Code Style Code Style
---------- ----------
@ -28,30 +28,18 @@ Akka is using ``Scalariform`` to format the source code as part of the build. So
Process Process
------- -------
The full process is described in `The Akka Contributor Guidelines`_. In summary:
* Make sure you have signed the Akka CLA, if not, `sign it online <http://www.typesafe.com/contribute/cla>`_. * Make sure you have signed the Akka CLA, if not, `sign it online <http://www.typesafe.com/contribute/cla>`_.
* Pick a ticket, if there is no ticket for your work then create one first. * Pick a ticket, if there is no ticket for your work then create one first.
* Start working in a feature branch. Name it something like ``wip-<ticket number>-<descriptive name>-<your username>``. * Fork `akka/akka <https://github.com/akka/akka>`_. Start working in a feature branch.
* When you are done, create a GitHub Pull-Request towards the targeted branch and email the Akka Mailing List that you want it reviewed * When you are done, create a GitHub Pull-Request towards the targeted branch.
* When there's consensus on the review, someone from the Akka Core Team will merge it. * When there's consensus on the review, someone from the Akka Core Team will merge it.
Commit messages Commit messages
--------------- ---------------
Please follow these guidelines when creating public commits and writing commit messages. Please follow the conventions described in `The Akka Contributor Guidelines`_ when creating public commits and writing commit messages.
1. If your work spans multiple local commits (for example; if you do safe point commits while working in a topic branch or work in a branch for long time doing merges/rebases etc.) then please do **not** commit it all but rewrite the history by squashing the commits into a single big commit which you write a good commit message for (like discussed below). Here is a great article for how to do that: `http://sandofsky.com/blog/git-workflow.html <http://sandofsky.com/blog/git-workflow.html>`_. Every commit should be able to be used in isolation, cherry picked etc.
2. First line should be a descriptive sentence what the commit is doing. It should be possible to fully understand what the commit does by just reading this single line. It is **not** ok to only list the ticket number, type "minor fix" or similar. Include reference to ticket number, prefixed with #, at the end of the first line. If the commit is a **small** fix, then you are done. If not, go to 3.
3. Following the single line description should be a blank line followed by an enumerated list with the details of the commit.
Example::
Completed replication over BookKeeper based transaction log. Fixes #XXX
* Details 1
* Details 2
* Details 3
Testing Testing
------- -------
@ -77,3 +65,5 @@ NetworkFailureTest
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
You can use the 'NetworkFailureTest' trait to test network failure. You can use the 'NetworkFailureTest' trait to test network failure.
.. _The Akka Contributor Guidelines: https://github.com/akka/akka/blob/master/CONTRIBUTING.md