This is an automated email from the ASF dual-hosted git repository.
kinow pushed a commit to branch release
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git
commit a0ed30415f921f7656e1bedcc5cda27d3d144391
Author: Bruno P. Kinoshita <ki...@apache.org>
AuthorDate: Sat Apr 27 21:38:03 2019 +1200
Update version numbers for commons foo release 1.0-alpha1
---
CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++------------
NOTICE.txt | 2 +-
README.md | 43 ++++++++-----------------------------
src/site/xdoc/issue-tracking.xml | 32 ++++++++++++++--------------
src/site/xdoc/mail-lists.xml | 20 ++++++++---------
5 files changed, 68 insertions(+), 75 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 208ed9c..33d3a10 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:contributing-md |
+ | 1) Re-generate using: mvn commons-build:contributing-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
@@ -50,48 +50,66 @@ Getting Started
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
-+ If you're planning to implement a new feature it makes sense to discuss
you're changes on the [dev list](https://commons.apache.org/mail-lists.html)
first. This way you can make sure you're not wasting your time on something
that isn't considered to be in Apache Commons Imaging's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ If you're planning to implement a new feature it makes sense to discuss your
changes on the [dev list](https://commons.apache.org/mail-lists.html) first.
This way you can make sure you're not wasting your time on something that isn't
considered to be in Apache Commons Imaging's scope.
++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already
exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
++ Find the corresponding [repository on
GitHub](https://github.com/apache/?query=commons-),
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your
forked repository.
Making Changes
--------------
-+ Create a topic branch from where you want to base your work (this is usually
the master/trunk branch).
++ Create a _topic branch_ for your isolated work.
+ * Usually you should base your branch on the `master` or `trunk` branch.
+ * A good topic branch name can be the JIRA bug id plus a keyword, e.g.
`IMAGING-123-InputStream`.
+ * If you have submitted multiple JIRA issues, try to maintain separate
branches and pull requests.
+ Make commits of logical units.
+ * Make sure your commit messages are meaningful and in the proper format.
Your commit message should contain the key of the JIRA issue.
+ * e.g. `IMAGING-123: Close input stream earlier`
+ Respect the original code style:
+ Only use spaces for indentation.
- + Create minimal diffs - disable on save actions like reformat source code
or organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
- + Check for unnecessary whitespace with git diff --check before committing.
-+ Make sure your commit messages are in the proper format. Your commit message
should contain the key of the JIRA issue.
-+ Make sure you have added the necessary tests for your changes.
+ + Create minimal diffs - disable _On Save_ actions like _Reformat Source
Code_ or _Organize Imports_. If you feel the source code should be reformatted
create a separate PR for this change first.
+ + Check for unnecessary whitespace with `git diff` -- check before
committing.
++ Make sure you have added the necessary tests for your changes, typically in
`src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was
accidentally broken.
Making Trivial Changes
----------------------
+The JIRA tickets are used to generate the changelog for the next release.
+
For changes of a trivial nature to comments and documentation, it is not
always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with
'(doc)' instead of a ticket number.
+
Submitting Changes
------------------
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
++ Sign and submit the Apache [Contributor License Agreement][cla] if you
haven't already.
+ * Note that small patches & typical bug fixes do not require a CLA as
+ clause 5 of the [Apache
License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
+ covers them.
+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
++ Submit a _Pull Request_ to the corresponding repository in the `apache`
organization.
+ * Verify _Files Changed_ shows only your intended changes and does not
+ include additional files like `target/*.class`
+ Update your JIRA ticket and include a link to the pull request in the ticket.
+If you prefer to not use GitHub, then you can instead use
+`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
+
+
Additional Resources
--------------------
+ [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons Imaging JIRA project
page](https://issues.apache.org/jira/browse/IMAGING)
++ [Apache Commons Imaging JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
-+ [GitHub pull request
documentation](https://help.github.com/send-pull-requests/)
++ [GitHub pull request
documentation](https://help.github.com/articles/creating-a-pull-request/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.net`
[cla]:https://www.apache.org/licenses/#clas
+[jira]:https://issues.apache.org/jira/browse/IMAGING
diff --git a/NOTICE.txt b/NOTICE.txt
index dcd3c34..c373fa9 100644
--- a/NOTICE.txt
+++ b/NOTICE.txt
@@ -1,5 +1,5 @@
Apache Commons Imaging
-Copyright 2007-2018 The Apache Software Foundation
+Copyright 2007-2019 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
diff --git a/README.md b/README.md
index 1c3f0db..4dd3397 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 1) Re-generate using: mvn commons-build:readme-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
@@ -43,7 +43,10 @@
Apache Commons Imaging
===================
-[](https://travis-ci.org/apache/commons-imaging)
+[](https://travis-ci.org/apache/commons-imaging)
+[](https://coveralls.io/r/apache/commons-imaging)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-imaging/)
+[](https://javadoc.io/doc/org.apache.commons/commons-imaging/1.0)
Apache Commons Imaging (previously Sanselan) is a pure-Java image library.
@@ -51,51 +54,23 @@ Documentation
-------------
More information can be found on the [Apache Commons Imaging
homepage](https://commons.apache.org/proper/commons-imaging).
-The
[Javadoc](https://commons.apache.org/proper/commons-imaging/javadocs/api-release)
can be browsed.
+The [Javadoc](https://commons.apache.org/proper/commons-imaging/apidocs) can
be browsed.
Questions related to the usage of Apache Commons Imaging should be posted to
the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
-There is currently no stable release of Imaging. However you can pull the
latest SNAPSHOT from the Apache snapshot repository by adding the snapshot
repository to your pom.xml:
-
-```xml
-<repository>
- <id>apache.snapshots</id>
- <name>Apache Development Snapshot Repository</name>
- <url>https://repository.apache.org/content/repositories/snapshots/</url>
- <releases>
- <enabled>false</enabled>
- </releases>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
-</repository>
-```
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-imaging/download_imaging.cgi).
-Then you can use the SNAPSHOT version of Commons Imaging in your pom.xml:
+Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-imaging</artifactId>
- <version>1.0-SNAPSHOT</version>
-</dependency>
-```
-
-The last stable release of Sanselan, before it was renamed to Imaging, was
0.97. You may:
-+ Download source and binaries from our [download
page](https://commons.apache.org/proper/commons-imaging/download_sanselan.cgi).
-+ Pull it from the central Maven repositories:
-
-```xml
-<dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-sanselan</artifactId>
- <version>0.97</version>
+ <version>1.0</version>
</dependency>
```
-Note that Commons Imaging and Commons Sanselan are neither binary nor source
compatible.
-
Contributing
------------
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index a571148..a1a2c47 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -26,7 +26,7 @@ limitations under the License.
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:jira-page |
+ | 1) Re-generate using: mvn commons-build:jira-page |
| |
| 2) Set the following properties in the component's pom: |
| - commons.jira.id (required, alphabetic, upper case) |
@@ -43,35 +43,35 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Imaging Issue tracking</title>
- <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Imaging Issue tracking</title>
+ <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
</properties>
<body>
- <section name="Commons Imaging Issue tracking">
+ <section name="Apache Commons Imaging Issue tracking">
<p>
- Commons Imaging uses <a href="http://issues.apache.org/jira/";>ASF
JIRA</a> for tracking issues.
- See the <a href="http://issues.apache.org/jira/browse/IMAGING";>Commons
Imaging JIRA project page</a>.
+ Apache Commons Imaging uses <a
href="https://issues.apache.org/jira/";>ASF JIRA</a> for tracking issues.
+ See the <a href="https://issues.apache.org/jira/browse/IMAGING";>Apache
Commons Imaging JIRA project page</a>.
</p>
<p>
- To use JIRA you may need to <a
href="http://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
+ To use JIRA you may need to <a
href="https://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
(if you have previously created/updated Commons issues using Bugzilla an
account will have been automatically
- created and you can use the <a
href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
+ created and you can use the <a
href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
page to get a new password).
</p>
<p>
If you would like to report a bug, or raise an enhancement request with
- Commons Imaging please do the following:
+ Apache Commons Imaging please do the following:
<ol>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
If you find your issue listed then please add a comment with your
details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
- <li>Submit either a <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=1&priority=4&assignee=-1";>bug
report</a>
- or <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
+ <li>Submit either a <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=1&priority=4&assignee=-1";>bug
report</a>
+ or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
</ol>
</p>
@@ -80,7 +80,7 @@ limitations under the License.
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed
enhancements</li>
- <li>the developers of Commons Imaging are all unpaid volunteers</li>
+ <li>the developers of Apache Commons Imaging are all unpaid
volunteers</li>
</ul>
</p>
@@ -92,9 +92,9 @@ limitations under the License.
<p>
You may also find these links useful:
<ul>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Commons Imaging bugs</a></li>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Commons Imaging bugs</a></li>
- <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC";>All
Commons Imaging bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Imaging bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Imaging bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Imaging bugs</a></li>
</ul>
</p>
</section>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index a6f9196..ea5408c 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -26,7 +26,7 @@ limitations under the License.
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:mail-page |
+ | 1) Re-generate using: mvn commons-build:mail-page |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
@@ -41,14 +41,14 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons Imaging Mailing Lists</title>
- <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons Imaging Mailing Lists</title>
+ <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
</properties>
<body>
<section name="Overview">
<p>
- <a href="index.html">Commons Imaging</a> shares mailing lists with all
the other
+ <a href="index.html">Apache Commons Imaging</a> shares mailing lists
with all the other
<a href="http://commons.apache.org/components.html";>Commons
Components</a>.
To make it easier for people to only read messages related to
components they are interested in,
the convention in Commons is to prefix the subject line of messages
with the component's name,
@@ -58,11 +58,11 @@ limitations under the License.
</ul>
</p>
<p>
- Questions related to the usage of Commons Imaging should be posted to
the
+ Questions related to the usage of Apache Commons Imaging should be
posted to the
<a href="http://mail-archives.apache.org/mod_mbox/commons-user/";>User
List</a>.
<br />
The <a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>Developer List</a>
- is for questions and discussion related to the development of Commons
Imaging.
+ is for questions and discussion related to the development of Apache
Commons Imaging.
<br />
Please do not cross-post; developers are also subscribed to the user
list.
<br />
@@ -76,9 +76,9 @@ limitations under the License.
</p>
</section>
- <section name="Commons Imaging Mailing Lists">
+ <section name="Apache Commons Imaging Mailing Lists">
<p>
- <strong>Please prefix the subject line of any messages for <a
href="index.html">Commons Imaging</a>
+ <strong>Please prefix the subject line of any messages for <a
href="index.html">Apache Commons Imaging</a>
with <i>[imaging]</i></strong> - <i>thanks!</i>
<br />
<br />
@@ -99,7 +99,7 @@ limitations under the License.
<td>
<strong>Commons User List</strong>
<br /><br />
- Questions on using Commons Imaging.
+ Questions on using Apache Commons Imaging.
<br /><br />
</td>
<td><a
href="mailto:user-subscr...@commons.apache.org";>Subscribe</a></td>
@@ -117,7 +117,7 @@ limitations under the License.
<td>
<strong>Commons Developer List</strong>
<br /><br />
- Discussion of development of Commons Imaging.
+ Discussion of development of Apache Commons Imaging.
<br /><br />
</td>
<td><a
href="mailto:dev-subscr...@commons.apache.org";>Subscribe</a></td>
