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/09/29 21:31:51 UTC
git commit: METAMODEL-81: Updated CONTRIBUTE.md
Repository: incubator-metamodel
Updated Branches:
refs/heads/master cd147b26b -> 3cdce4cf6
METAMODEL-81: Updated CONTRIBUTE.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/commit/3cdce4cf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/tree/3cdce4cf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metamodel/diff/3cdce4cf
Branch: refs/heads/master
Commit: 3cdce4cf6b99c56cb1b04b6385e6f2e8ab0dbc53
Parents: cd147b2
Author: Kasper Sørensen <i....@gmail.com>
Authored: Mon Sep 29 21:30:35 2014 +0200
Committer: Kasper Sørensen <i....@gmail.com>
Committed: Mon Sep 29 21:30:35 2014 +0200
----------------------------------------------------------------------
CONTRIBUTE.md | 20 +++++++++++++++-----
README | 7 ++++++-
2 files changed, 21 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-metamodel/blob/3cdce4cf/CONTRIBUTE.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
index 9a8670b..62cebf4 100644
--- a/CONTRIBUTE.md
+++ b/CONTRIBUTE.md
@@ -4,7 +4,7 @@ Before anything else, thank you. Thank you for taking some of your precious time
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
+### Starter issues to work on
If you're looking for a relevant issue to work on, we suggest you to do the following:
@@ -12,8 +12,7 @@ If you're looking for a relevant issue to work on, we suggest you to do the foll
* Check the issues in JIRA with the 'starter' label: https://issues.apache.org/jira/issues/?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
+### Build the code
Fork and clone the repository:
@@ -28,13 +27,24 @@ Try your first build:
> mvn clean install
```
-## About tests
+### Report issues and ideas
+
+Please use our [JIRA system](https://issues.apache.org/jira/browse/METAMODEL) to report issues and ideas that you might work on. This is a great way to bounce ideas and get input to your contributions.
+
+### Submitting your patch
+
+When submitting your patch, keep in mind that it should be easy for others to review. For this reason we have two preferred ways to submit a patch - you can select the approach that fits you the best:
+
+ * Use "git diff" to make a .patch file and submit it via our [Review Board](https://reviews.apache.org/groups/metamodel/).
+ * Fork our [GitHub mirror](https://github.com/apache/incubator-metamodel) and post a [Pull Request](https://github.com/apache/incubator-metamodel/pulls).
+
+### 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
+### Coding guidelines
If you plan on submitting code, read this carefully. Please note it is not yet complete.
http://git-wip-us.apache.org/repos/asf/incubator-metamodel/blob/3cdce4cf/README
----------------------------------------------------------------------
diff --git a/README b/README
index 1a7025a..2fdad7a 100644
--- a/README
+++ b/README
@@ -35,4 +35,9 @@ If you also want to run integration tests:
1) Copy the file 'example-metamodel-integrationtest-configuration.properties' to your user home.
2) Remove the 'example-' prefix from its filename
3) Modify the file to enable properties of the integration tests that you're interested in.
-4) Re-run "mvn clean install".
\ No newline at end of file
+4) Re-run "mvn clean install".
+
+Contributing
+============
+
+https://github.com/apache/incubator-metamodel/blob/master/CONTRIBUTE.md
\ No newline at end of file