You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@marmotta.apache.org by wi...@apache.org on 2013/02/20 16:29:05 UTC
svn commit: r1448229 - in /incubator/marmotta/site/trunk/content:
markdown/development.md markdown/installation.md
resources/images/git-branching-workflow.png site.xml
Author: wikier
Date: Wed Feb 20 15:29:05 2013
New Revision: 1448229
URL: http://svn.apache.org/r1448229
Log:
added more documentation about development of marmotta
Added:
incubator/marmotta/site/trunk/content/markdown/development.md
incubator/marmotta/site/trunk/content/resources/images/git-branching-workflow.png (with props)
Modified:
incubator/marmotta/site/trunk/content/markdown/installation.md
incubator/marmotta/site/trunk/content/site.xml
Added: incubator/marmotta/site/trunk/content/markdown/development.md
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/development.md?rev=1448229&view=auto
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/development.md (added)
+++ incubator/marmotta/site/trunk/content/markdown/development.md Wed Feb 20 15:29:05 2013
@@ -0,0 +1,177 @@
+# Development
+
+Here you can find the development related issues when working with the Apache
+Marmotta source code and/or contributing to it.
+
+## Communication
+
+The project uses different [mailing lists](http://marmotta.incubator.apache.org/mail-lists.html)
+for internal communication:
+
+* Everything has to be discussed on the developer mailing list <[dev@.marmotta.incubator.apache.org](mailto:dev@.marmotta.incubator.apache.org)> prior to any implementation action. If it is not on the list, it did not happen ([the Apache way](http://incubator.apache.org/learn/theapacheway.html)).
+* Users' support is done at the users mailing list <[user@.marmotta.incubator.apache.org](mailto:user@.marmotta.incubator.apache.org)>.
+
+## Source code
+
+The projects uses [Git](http://git-scm.com) to manage the source code. The [repository](source-repository.html) is available at:
+
+ git:https://git-wip-us.apache.org/repos/asf/incubator-marmotta.git
+
+Marmotta uses a [branching workflow](http://git-scm.com/book/en/Git-Branching-Branching-Workflows)
+depicted by the following diagram:
+
+
+
+Where we have a stable `master` branch and a unstable `develop` branch. Besides, optionally `topic`
+branches could be open for some topics/issues, which don't necessarily need to be pushed to the public
+repository.
+
+The code of this web site is also available, via [Subversion](http://subversion.apache.org/) in this case:
+
+ svn:https://svn.apache.org/repos/asf/incubator/marmotta/site/trunk
+
+Marmotta is using [Apache Maven](http://maven.apache.org) as its build system, check out how to
+[build it from the source code](installation.html#src).
+
+## Issue tracker
+
+Apache Marmotta uses [Jira](http://www.atlassian.com/software/jira) for tracking bug reports and
+requests for improvements, new features, and other changes. The issue tracker is available at
+[http://issues.apache.org/jira/browse/MARMOTTA](http://issues.apache.org/jira/browse/MARMOTTA), and is anonymous
+readable by everyone. An account is needed to create new issues or to comment on existing issues.
+
+When reporting a new issue, please try to be as descriptive as possible. For instance, the issue
+summary should be a short and clear statement that indicates the scope of the issue; you are probably
+being too verbose if you exceed the length of the text field. Use the Environment and Description
+fields to provide more detailed information. Besides, use the right type and assigned to the corrrect
+component to allow the project to be more effective on its resolution. See below some additional
+information and guidelines on creating and managing issues.
+
+### Issue type
+
+When creating a new issue, select the issue type based as follows:
+
+<table>
+ <thead>
+ <tr>
+ <th>Issue type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><em>Bug</em></td>
+ <td>Bug reports are used for cases where Marmotta fails not function as it should (as defined by some documentation). If you are not certain whether the issue you've found is actually a bug, please ask at the mailing list first for help.</td>
+ </tr>
+ <tr>
+ <td><em>New Feature</em></td>
+ <td>Use a feature request when Marmotta does not have some functionality you need.</td>
+ </tr>
+ <tr>
+ <td><em>Improvement</em></td>
+ <td>Use an improvement request to suggest improvements to existing features. Typical improvement requests are about updating documentation, increasing stability and performance, simplifying the implementation, or other such changes that make Marmotta better without introducing new features or fixing existing bugs.</td>
+ </tr>
+ <tr>
+ <td><em>Test</em></td>
+ <td>Use this type when contributing test cases for existing features. Normally test cases should be contributed as a part of the original feature request or as regression tests associated with bug reports, but sometimes you just want to extend test coverage by introducing new test cases. This issue type is for such cases.</td>
+ </tr>
+ <tr>
+ <td><em>Task</em></td>
+ <td>Used only for issues related to project infrastructure.</td>
+ </tr>
+ </tbody>
+</table>
+
+
+### Issue priority
+
+Issue priority should be set according to the following:
+
+<table>
+ <thead>
+ <tr>
+ <th>Issue priority</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><em>Blocker</em></td>
+ <td>Legal or other fundamental issue that makes it impossible to release Marmotta code</td>
+ </tr>
+ <tr>
+ <td><em>Critical</em></td>
+ <td>Major loss of functionality that affects many Marmotta users</td>
+ </tr>
+ <tr>
+ <td><em>Major</em></td>
+ <td>Important issue that should be resolved soon</td>
+ </tr>
+ <tr>
+ <td><em>Minor</em></td>
+ <td>Nice to have issues</td>
+ </tr>
+ <tr>
+ <td><em>Trivial</em></td>
+ <td>Trivial changes that can be applied whenever someone has extra time</td>
+ </tr>
+ </tbody>
+</table>
+
+### Issue workflow
+
+Marmotta issues can transition through a number of states while being processed:
+
+<table>
+ <thead>
+ <tr>
+ <th>State</th>
+ <th>Description</th>
+ <th>Next states in workflow</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><em>Open</em></td>
+ <td>The issue has just been created</td>
+ <td><em>In Pogress</em></td>
+ </tr>
+ <tr>
+ <td><em>In Progress</em></td>
+ <td>Work has started on the issue</td>
+ <td><em>Resolved</em>, <em>Open</em></td>
+ </tr>
+ <tr>
+ <td><em>Resolved</em></td>
+ <td>The issue has been resolved from the developers point of view. Documentation and Testcases have been created and updated as required. Issue is ready for release.</td>
+ <td><em>Reopened</em>, <em>Closed</em></td>
+ </tr>
+ <tr>
+ <td><em>Reopened</em></td>
+ <td>A resolved issue has been recognized to contain bugs or to be incomplete and thus has been reopened.</td>
+ <td><em>In Progress</em>, <em>Resolved</em></td>
+ </tr>
+ <tr>
+ <td><em>Closed</em></td>
+ <td>Work on this issue has finished and it is included in the release.</td>
+ <td>--</td>
+ </tr>
+ </tbody>
+</table>
+
+Users generally create issues and provide feedback while work on the issue is in progress. When the developer thinks the issue has been resolved, he resolves the issue. At this point, the user may test the resolution and reopen the issue if it has not really be solved. Otherwise the user may just acknowledge the fix.
+
+Developers transition the issue through the workflow while working on it. When done with the issue, they mark the issue resolved with the appropriate resolution and ask the reporting user to confirm.
+
+Issues are closed once the project against which it has been reported has been released. Issues once closed cannot be opened again. Rather new issues should be created against the new release to have broken implementations fixed or extended.
+
+## Development Practices
+
+@@TODO@@
+
+## Contributing
+
+When reporting a bug, requesting a feature or propose an improvement, it is a good thing to attach
+a patch to the issue. This may speed up issue processing and helps you being recognized as a good
+community member leading to closer involvement with Marmotta.
+
Modified: incubator/marmotta/site/trunk/content/markdown/installation.md
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/markdown/installation.md?rev=1448229&r1=1448228&r2=1448229&view=diff
==============================================================================
--- incubator/marmotta/site/trunk/content/markdown/installation.md (original)
+++ incubator/marmotta/site/trunk/content/markdown/installation.md Wed Feb 20 15:29:05 2013
@@ -135,7 +135,7 @@ Afterwards, change to the newly created
To start a clean Marmotta installation.
-## Installation (source)
+## Installation (source) <a name="src"></a>
Considering you have git and maven installed, you just need to run the following commands:
Added: incubator/marmotta/site/trunk/content/resources/images/git-branching-workflow.png
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/resources/images/git-branching-workflow.png?rev=1448229&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/marmotta/site/trunk/content/resources/images/git-branching-workflow.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/marmotta/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/incubator/marmotta/site/trunk/content/site.xml?rev=1448229&r1=1448228&r2=1448229&view=diff
==============================================================================
--- incubator/marmotta/site/trunk/content/site.xml (original)
+++ incubator/marmotta/site/trunk/content/site.xml Wed Feb 20 15:29:05 2013
@@ -48,11 +48,14 @@
</bannerRight>
<body>
+
<menu name="Apache Marmotta">
<item name="Home" href="/index.html" />
<item name="Download" href="download.html" />
<item name="Installation" href="installation.html" />
<item name="Configuration" href="configuration.html" />
+ <item name="Development" href="development.html" />
+ <item name="Wiki" href="http://wiki.apache.org/marmotta" />
<item name="Privacy" href="privacy.html" />
</menu>
<!--<menu ref="parent" inherit="bottom" />-->
@@ -64,6 +67,9 @@
<item name="Become a Sponsor" href="http://www.apache.org/foundation/sponsorship.html" />
<item name="Security" href="http://www.apache.org/security/" />
</menu>
+
+ <footer>Licensed under the Apache License, Version 2.0. Apache, Stanbol and the Apache feather and Marmotta logos are trademarks of The Apache Software Foundation.</footer>
+
</body>
<!--<googleAnalyticsAccountId>UA-38225305-1</googleAnalyticsAccountId>-->