You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metamodel.apache.org by ka...@apache.org on 2014/05/02 11:48:10 UTC

[1/2] git commit: Added first draft CONTRIBUTE.md file

Repository: incubator-metamodel
Updated Branches:
  refs/heads/master c9a6cd1f8 -> cc8933453


Added first draft CONTRIBUTE.md file

Project: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/commit/43033bd6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/tree/43033bd6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/diff/43033bd6

Branch: refs/heads/master
Commit: 43033bd66a7c92d2fe9e421f9aa5d6e0f9125ecc
Parents: a9d89dc
Author: Kasper Sørensen <i....@gmail.com>
Authored: Fri May 2 11:47:51 2014 +0200
Committer: Kasper Sørensen <i....@gmail.com>
Committed: Fri May 2 11:47:51 2014 +0200

----------------------------------------------------------------------
 CONTRIBUTE.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-metamodel/blob/43033bd6/CONTRIBUTE.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
new file mode 100644
index 0000000..4cc0634
--- /dev/null
+++ b/CONTRIBUTE.md
@@ -0,0 +1,45 @@
+## Thank you!
+
+Before anything else, thank you. Thank you for taking some of your precious time helping this project move forward.
+
+This guide will help you get started with Apache MetaModel's development environment. You'll also find the set of rules you're expected to follow in order to submit improvements and fixes to Apache MetaModel.
+
+## Starter issues to work on
+
+If you're looking for a relevant issue to work on, we suggest you to do the following:
+
+* Join the @dev mailing list (send a mail to dev-subscribe@metamodel.incubator.apache.org, then afterwards communicate via dev@metamodel.incubator.apache.org).
+* Check the issues in JIRA with the 'starter' label: https://issues.apache.org/jira/browse/METAMODEL-17?jql=project%20%3D%20METAMODEL%20AND%20labels%20%3D%20starter
+* If you have something else on your mind, make yourself heard on the @dev mailing list.
+
+
+## Build the code
+
+Fork and clone the repository:
+
+```
+> git clone https://git-wip-us.apache.org/repos/asf/incubator-metamodel.git MetaModel
+```
+
+Try your first build:
+
+```
+> cd MetaModel
+> mvn clean install
+```
+
+## About tests
+
+By default the build will include all self-contained tests, including some quick integration tests to embedded databases like H2, Derby, HSQLDB etc.
+
+Some tests have external dependencies to running servers etc. Those tests can be configured by adding a file called **metamodel-integrationtest-configuration.properties** to your local user's home folder. You can take a look at the [example-metamodel-integrationtest-configuration.properties file](https://raw.githubusercontent.com/apache/incubator-metamodel/master/example-metamodel-integrationtest-configuration.properties) to see which properties are available in order to configure the external server connections.
+
+## Coding guidelines
+
+If you plan on submitting code, read this carefully. Please note it is not yet complete.
+
+We stick to the [Google Java Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html), with a few modifications/exceptions:
+
+* We often prefix instance variables with an underscore (_). This to easily distinguish between method local and instance variables, as well as avoiding the overuse of the 'this' keyword in e.g. setter methods.
+* We format indentation using spaces, not tabs. We use 4 spaces for each indentation.
+* We format line wrapping using a desired max line length of 120 characters.
\ No newline at end of file


[2/2] git commit: Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/incubator-metamodel.git

Posted by ka...@apache.org.
Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/incubator-metamodel.git

Project: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/commit/cc893345
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/tree/cc893345
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/diff/cc893345

Branch: refs/heads/master
Commit: cc8933453f2d2c32e30dbfc031faf2233f852b9b
Parents: 43033bd c9a6cd1
Author: Kasper Sørensen <i....@gmail.com>
Authored: Fri May 2 11:48:01 2014 +0200
Committer: Kasper Sørensen <i....@gmail.com>
Committed: Fri May 2 11:48:01 2014 +0200

----------------------------------------------------------------------
 CHANGES.txt        |  5 ++---
 core/pom.xml       |  2 +-
 couchdb/pom.xml    |  2 +-
 csv/pom.xml        |  2 +-
 excel/pom.xml      |  2 +-
 fixedwidth/pom.xml |  2 +-
 full/pom.xml       |  2 +-
 hbase/pom.xml      |  5 ++---
 jdbc/pom.xml       |  2 +-
 mongodb/pom.xml    |  2 +-
 openoffice/pom.xml |  2 +-
 pojo/pom.xml       |  2 +-
 pom.xml            | 10 ++++------
 salesforce/pom.xml |  2 +-
 spring/pom.xml     |  2 +-
 sugarcrm/pom.xml   |  2 +-
 xml/pom.xml        |  2 +-
 17 files changed, 22 insertions(+), 26 deletions(-)
----------------------------------------------------------------------