You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2016/10/06 14:43:48 UTC
[1/4] jena git commit: Drafts of BUILD and CONTRIBUTE
Repository: jena
Updated Branches:
refs/heads/master ec9573f2a -> d14ce97e9
Drafts of BUILD and CONTRIBUTE
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/b5cb136f
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/b5cb136f
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/b5cb136f
Branch: refs/heads/master
Commit: b5cb136fce5bed899324cd7f24250e9ff32f4214
Parents: fbb53ef
Author: Andy Seaborne <an...@apache.org>
Authored: Sun Oct 2 20:34:35 2016 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Sun Oct 2 20:34:35 2016 +0100
----------------------------------------------------------------------
BUILD.md | 66 +++++++++++++++++++++++++++++
CONTRIBUTING.md | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 182 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/jena/blob/b5cb136f/BUILD.md
----------------------------------------------------------------------
diff --git a/BUILD.md b/BUILD.md
new file mode 100644
index 0000000..0f0adbf
--- /dev/null
+++ b/BUILD.md
@@ -0,0 +1,66 @@
+Apache Jena : Build from Source
+===============================
+
+It is not normally necessary to build from source. Apache Jena provides already-built maven artifacts, available from the central maven repositories.
+
+## Binaries
+
+See http://jena.apache.org/download/
+
+For most usage, there is no requirment to build from source. Use maven
+or other build system that can download from the central repositories.
+
+ <dependency>
+ <groupId>org.apache.jena</groupId>
+ <artifactId>apache-jena-libs</artifactId>
+ <type>pom</type>
+ <version>X.Y.Z</version>
+ </dependency>
+
+The latest Apache Jena Fuseki can be obtained via http://jena.apache.org/download/.
+
+There is also a package of libraries for offline installation.
+
+## Source
+
+Building Jena requires a Java8 JDK, Maven 3, and a network connection.
+
+### Obtain the source
+
+You can get the current development code by cloning:
+
+ git clone https://github.com/apache/jena/
+
+or the Apache primary code repository for Jena:
+
+ git clone https://git-wip-us.apache.org/repos/asf/jena.git
+
+For the signed source of the latest release, go to:
+
+http://apache.org/dist/jena/source/
+
+with previous versions available at:
+
+http://archive.apache.org/dist/jena/source/
+
+These are the formal files that define an Apache Jena release.
+
+### Build the source
+
+Apache Jena uses maven as its build system.
+
+ mvn clean install
+
+A faster, but abbreviated, build of the main modules, including ARQ,
+TDB, command line tools and Fuseki2.
+
+ mvn clean install -Pdev
+
+Once the whole of Jena has been built once, individual modules can be incrementally
+built using maven in their module directory.
+
+## Build Notes
+
+The TDB tests on Microsoft Windows use a large amount of temporary disk space.
+This is because databases can not be completely deleted until the JVM exits on
+this operating system.
http://git-wip-us.apache.org/repos/asf/jena/blob/b5cb136f/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2170476
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,116 @@
+Apache Jena : Contributing
+==========================
+
+The project welcomes contributions, large and small, from anyone.
+
+The mailing list for project-wide discussions is dev@jena.apache.org and all
+development work happens in public, using that list.
+
+The processes described here are guidelines, rather than absolute
+requirements.
+
+
+## Contributions
+
+Contributions can be made by:
+
+* Github pull requests (preferred)
+* JIRA and patches
+* Other
+
+Contributions should include:
+
+* Tests
+* Documentation as needed
+
+Documentation is kept and published with Apache's svnpubsub system:
+
+ https://svn.apache.org/repos/asf/jena/site/trunk
+
+## Workflow
+
+### JIRA
+
+The project uses a JIRA instance to track work. Please create a JITA so
+that we can track a contribution.
+
+ https://issues.apache.org/jira/browse/JENA
+
+### Github
+
+It is useful to create a JIRA then use teh JIRA number (e.g. JENA-9999)
+in the Pull Request title. This activates the automated mirroring of
+discussions onto the project developers mailing list.
+
+To make a contribution:
+
+* On github, fork http://github.com/apache/jena into you github account.
+* Create a branch in your fork for hthe contribution.
+* Make your changes. Include the Apache source header at the top of each file.
+* Generate a pull request via github. Further changes to your branch will automatically
+ show up in the pull request
+
+The project development mailing list is automatically notified of new pull
+requests and JIRA ia also automatically updated if the JIRA id is in the pull request
+title.
+
+### Discussion and Merging
+
+A project committer will review the contribution and coordinate any project-wide discussion
+needed. Review and discussion of the pull request itself takes place on
+github.
+
+The committer review guide:
+
+https://jena.apache.org/getting_involved/reviewing_contributions.html
+
+### Patches
+
+An alternative is to upload a patch/diff to JIRA.
+
+### Code style
+
+Code style is about making the code clear for the next person
+who looks at the code.
+
+The project prefers code to be formatted in the common java style with
+sensible deviation for short forms.
+
+The project does not enforce a particular style but asks for:
+
+* Kernighan and Ritchie style "Egyptian brackets" braces.
+* Spaces for indentation
+* No `@author` tags.
+* One statement per line
+* Indent level 4 for Java
+* Indent level 2 for XML
+
+See, for illustration:
+https://google.github.io/styleguide/javaguide.html#s4-formatting
+
+The codebase has a long history - not all of it follows this style.
+
+The code should have no warnings, in particular, use `@Override` and types
+for generics, and don't declared checked exceptions that are not used.
+Use `@SuppressWarnings("unused")` as necessary.
+
+### Legal
+
+All contributions are understood to be made as contributions to the
+Apache Software Foundation. These are then incorporated into the project
+ocdebase and licneses under the Apache License 2.0.
+
+You, as an individual, must be entitled to make the contribution to the
+project. If the contrbution is part of your employment, please arrange
+this before making the contribution.
+
+For a large contribution, the Project may ask for a specific Software
+Grant from the contributor.
+
+If in doubt, or you have any questions, ask on the dev@jena.apache.org
+mailing list. Legal issues are easier to deal with if done before
+contributing, rather than after.
+
+The project cannot accept contributions with unclear ownership nor
+contributions containing work by other people without a clear agreement
+from those people.
[4/4] jena git commit: JENA-1234: Merge commit 'refs/pull/174/head'
of github.com:apache/jena
Posted by an...@apache.org.
JENA-1234: Merge commit 'refs/pull/174/head' of github.com:apache/jena
This closes #174.
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/d14ce97e
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/d14ce97e
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/d14ce97e
Branch: refs/heads/master
Commit: d14ce97e9c61138d35f03dd7fc0c2604f8a9d726
Parents: ec9573f 03092e6
Author: Andy Seaborne <an...@apache.org>
Authored: Thu Oct 6 15:42:37 2016 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Thu Oct 6 15:42:37 2016 +0100
----------------------------------------------------------------------
BUILD.md | 66 ++++++++++++++++++++++++++++
CONTRIBUTING.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 186 insertions(+)
----------------------------------------------------------------------
[2/4] jena git commit: Don't mix reformatting and functional changes
Posted by an...@apache.org.
Don't mix reformatting and functional changes
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/c12b574a
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/c12b574a
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/c12b574a
Branch: refs/heads/master
Commit: c12b574abc18e5e72a84afb16b162d74a82364e7
Parents: b5cb136
Author: Andy Seaborne <an...@apache.org>
Authored: Sun Oct 2 20:57:34 2016 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Sun Oct 2 20:57:34 2016 +0100
----------------------------------------------------------------------
CONTRIBUTING.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/jena/blob/c12b574a/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2170476..4eb447f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -68,7 +68,7 @@ https://jena.apache.org/getting_involved/reviewing_contributions.html
An alternative is to upload a patch/diff to JIRA.
-### Code style
+### Code
Code style is about making the code clear for the next person
who looks at the code.
@@ -94,17 +94,21 @@ The code should have no warnings, in particular, use `@Override` and types
for generics, and don't declared checked exceptions that are not used.
Use `@SuppressWarnings("unused")` as necessary.
+Please don't mix reformatting and functional changes; it makes it harder
+to review.
+
### Legal
All contributions are understood to be made as contributions to the
-Apache Software Foundation. These are then incorporated into the project
-ocdebase and licneses under the Apache License 2.0.
+Apache Software Foundation by the person makign the pull request. These
+are then incorporated into the project codebase and licnesed under the
+Apache License 2.0.
You, as an individual, must be entitled to make the contribution to the
project. If the contrbution is part of your employment, please arrange
this before making the contribution.
-For a large contribution, the Project may ask for a specific Software
+For a large contribution, the project may ask for a specific Software
Grant from the contributor.
If in doubt, or you have any questions, ask on the dev@jena.apache.org
[3/4] jena git commit: Fix mistakes noted in review comments
Posted by an...@apache.org.
Fix mistakes noted in review comments
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/03092e6d
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/03092e6d
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/03092e6d
Branch: refs/heads/master
Commit: 03092e6d6d2e6220a33f27a2bbec13633fa55d73
Parents: c12b574
Author: Andy Seaborne <an...@apache.org>
Authored: Thu Oct 6 15:33:22 2016 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Thu Oct 6 15:33:22 2016 +0100
----------------------------------------------------------------------
CONTRIBUTING.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/jena/blob/03092e6d/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4eb447f..8b6ae89 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -31,27 +31,27 @@ Documentation is kept and published with Apache's svnpubsub system:
### JIRA
-The project uses a JIRA instance to track work. Please create a JITA so
+The project uses a JIRA instance to track work. Please create a JIRA so
that we can track a contribution.
https://issues.apache.org/jira/browse/JENA
### Github
-It is useful to create a JIRA then use teh JIRA number (e.g. JENA-9999)
+It is useful to create a JIRA then use the JIRA number (e.g. JENA-9999)
in the Pull Request title. This activates the automated mirroring of
discussions onto the project developers mailing list.
To make a contribution:
* On github, fork http://github.com/apache/jena into you github account.
-* Create a branch in your fork for hthe contribution.
+* Create a branch in your fork for the contribution.
* Make your changes. Include the Apache source header at the top of each file.
* Generate a pull request via github. Further changes to your branch will automatically
show up in the pull request
The project development mailing list is automatically notified of new pull
-requests and JIRA ia also automatically updated if the JIRA id is in the pull request
+requests and JIRA is also automatically updated if the JIRA id is in the pull request
title.
### Discussion and Merging
@@ -100,18 +100,18 @@ to review.
### Legal
All contributions are understood to be made as contributions to the
-Apache Software Foundation by the person makign the pull request. These
-are then incorporated into the project codebase and licnesed under the
+Apache Software Foundation by the person making the pull request. These
+are then incorporated into the project codebase and licensed under the
Apache License 2.0.
You, as an individual, must be entitled to make the contribution to the
-project. If the contrbution is part of your employment, please arrange
+project. If the contribution is part of your employment, please arrange
this before making the contribution.
For a large contribution, the project may ask for a specific Software
Grant from the contributor.
-If in doubt, or you have any questions, ask on the dev@jena.apache.org
+If in doubt, or if you have any questions, ask on the dev@jena.apache.org
mailing list. Legal issues are easier to deal with if done before
contributing, rather than after.