(commons-dbutils) branch master updated: Update using current templates

ggregory Wed, 20 Nov 2024 06:02:27 -0800

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git



The following commit(s) were added to refs/heads/master by this push:
     new 5c2f47d  Update using current templates
5c2f47d is described below

commit 5c2f47de252f8b51d7c68cbc8bf946640876f17d
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Nov 20 09:01:13 2024 -0500

    Update using current templates
---
 CONTRIBUTING.md | 14 ++++------
 README.md       | 85 +++++++++++++++------------------------------------------
 2 files changed, 28 insertions(+), 71 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3d3d80a..93c99be 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,28 +41,27 @@
 Contributing to Apache Commons DbUtils
 ======================
 
-You have found a bug or you have an idea for a cool new feature? Contributing 
code is a great way to give something back to
-the open source community. Before you dig right into the code there are a few 
guidelines that we need contributors to
-follow so that we can have a chance of keeping on top of things.
+Have you found a bug or have an idea for a cool new feature? Contributing code 
is a great way to give something back to the open-source community.
+Before you dig right into the code, we need contributors to follow a few 
guidelines to have a chance of keeping on top of things.
 
 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).
++ Make sure you have a [GitHub account](https://github.com/signup/free). This 
is not essential, but makes providing patches much easier.
 + 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 DbUtils'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.
 + 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.
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your 
forked repository. If you don't have a GitHub account, you can still clone the 
Commons repository.
 
 Making Changes
 --------------
 
 + Create a _topic branch_ for your isolated work.
   * Usually you should base your branch on the `master` branch.
-  * A good topic branch name can be the JIRA bug id plus a keyword, e.g. 
`DBUTILS-123-InputStream`.
+  * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. 
`DBUTILS-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.
@@ -72,7 +71,7 @@ Making 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.
++ Run all the tests with `mvn clean verify` to ensure nothing else was 
accidentally broken.
 
 Making Trivial Changes
 ----------------------
@@ -109,7 +108,6 @@ Additional Resources
 + [General GitHub documentation](https://help.github.com/)
 + [GitHub pull request 
documentation](https://help.github.com/articles/creating-a-pull-request/)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.net`
 
 [cla]:https://www.apache.org/licenses/#clas
 [jira]:https://issues.apache.org/jira/browse/DBUTILS
diff --git a/README.md b/README.md
index 23283a2..9eff675 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Apache Commons DbUtils
 
 [![Java 
CI](https://github.com/apache/commons-dbutils/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-dbutils/actions/workflows/maven.yml)
 [![Maven 
Central](https://img.shields.io/maven-central/v/commons-dbutils/commons-dbutils?label=Maven%20Central)](https://search.maven.org/artifact/commons-dbutils/commons-dbutils)
-[![Javadocs](https://javadoc.io/badge/commons-dbutils/commons-dbutils/1.8.1.svg)](https://javadoc.io/doc/commons-dbutils/commons-dbutils/1.8.1)
+[![Javadocs](https://javadoc.io/badge/commons-dbutils/commons-dbutils/1.9.0.svg)](https://javadoc.io/doc/commons-dbutils/commons-dbutils/1.9.0)
 
[![CodeQL](https://github.com/apache/commons-dbutils/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-dbutils/actions/workflows/codeql-analysis.yml)
 [![OpenSSF 
Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-dbutils/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-dbutils)
 
@@ -58,42 +58,52 @@ More information can be found on the [Apache Commons 
DbUtils homepage](https://c
 The [Javadoc](https://commons.apache.org/proper/commons-dbutils/apidocs) can 
be browsed.
 Questions related to the usage of Apache Commons DbUtils should be posted to 
the [user mailing list](https://commons.apache.org/mail-lists.html).
 
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
 You can download source and binaries from our [download 
page](https://commons.apache.org/proper/commons-dbutils/download_dbutils.cgi).
 
-Alternatively, you can pull it from  the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
 
 ```xml
 <dependency>
   <groupId>commons-dbutils</groupId>
   <artifactId>commons-dbutils</artifactId>
-  <version>1.8.1</version>
+  <version>1.9.0</version>
 </dependency>
 ```
 
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the 
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven 
goal to run all tests and checks.
+
 Contributing
 ------------
 
 We accept Pull Requests via GitHub. The [developer mailing 
list](https://commons.apache.org/mail-lists.html) is the main channel of 
communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
-+ Respect the code style.
++ Respect the existing code style for each file.
 + 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.
-+ Provide JUnit tests for your changes and make sure your changes don't break 
any existing tests by running ```mvn```.
++ Provide JUnit tests for your changes and make sure your changes don't break 
any existing tests by running `mvn`.
++ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, 
which contains all build checks.
++ To see the code coverage report, regardless of coverage failures, run `mvn 
clean site -Dcommons.jacoco.haltOnFailure=false`
 
 If you plan to contribute on a regular basis, please consider filing a 
[contributor license agreement](https://www.apache.org/licenses/#clas).
 You can learn more about contributing via GitHub in our [contribution 
guidelines](CONTRIBUTING.md).
 
 License
 -------
-This code is under the [Apache License 
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License 
v2](https://www.apache.org/licenses/LICENSE-2.0).
 
 See the `NOTICE.txt` file for required notices and attributions.
 
-Donations
----------
-You like Apache Commons DbUtils? Then [donate back to the 
ASF](https://www.apache.org/foundation/contributing.html) to support the 
development.
+Donating
+--------
+You like Apache Commons DbUtils? Then [donate back to the 
ASF](https://www.apache.org/foundation/contributing.html) to support 
development.
 
 Additional Resources
 --------------------
@@ -102,59 +112,8 @@ Additional Resources
 + [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/DBUTILS)
 + [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
 
 Apache Commons Components
 -------------------------
 
-| Component | GitHub Repository | Apache Homepage |
-| --------- | ----------------- | ----------------|
-| Apache Commons BCEL | [commons-bcel](https://github.com/apache/commons-bcel) 
| [commons-bcel](https://commons.apache.org/proper/commons-bcel) |
-| Apache Commons Beanutils | 
[commons-beanutils](https://github.com/apache/commons-beanutils) | 
[commons-beanutils](https://commons.apache.org/proper/commons-beanutils) |
-| Apache Commons BSF | [commons-bsf](https://github.com/apache/commons-bsf) | 
[commons-bsf](https://commons.apache.org/proper/commons-bsf) |
-| Apache Commons Build-plugin | 
[commons-build-plugin](https://github.com/apache/commons-build-plugin) | 
[commons-build-plugin](https://commons.apache.org/proper/commons-build-plugin) |
-| Apache Commons Chain | 
[commons-chain](https://github.com/apache/commons-chain) | 
[commons-chain](https://commons.apache.org/proper/commons-chain) |
-| Apache Commons CLI | [commons-cli](https://github.com/apache/commons-cli) | 
[commons-cli](https://commons.apache.org/proper/commons-cli) |
-| Apache Commons Codec | 
[commons-codec](https://github.com/apache/commons-codec) | 
[commons-codec](https://commons.apache.org/proper/commons-codec) |
-| Apache Commons Collections | 
[commons-collections](https://github.com/apache/commons-collections) | 
[commons-collections](https://commons.apache.org/proper/commons-collections) |
-| Apache Commons Compress | 
[commons-compress](https://github.com/apache/commons-compress) | 
[commons-compress](https://commons.apache.org/proper/commons-compress) |
-| Apache Commons Configuration | 
[commons-configuration](https://github.com/apache/commons-configuration) | 
[commons-configuration](https://commons.apache.org/proper/commons-configuration)
 |
-| Apache Commons Crypto | 
[commons-crypto](https://github.com/apache/commons-crypto) | 
[commons-crypto](https://commons.apache.org/proper/commons-crypto) |
-| Apache Commons CSV | [commons-csv](https://github.com/apache/commons-csv) | 
[commons-csv](https://commons.apache.org/proper/commons-csv) |
-| Apache Commons Daemon | 
[commons-daemon](https://github.com/apache/commons-daemon) | 
[commons-daemon](https://commons.apache.org/proper/commons-daemon) |
-| Apache Commons DBCP | [commons-dbcp](https://github.com/apache/commons-dbcp) 
| [commons-dbcp](https://commons.apache.org/proper/commons-dbcp) |
-| Apache Commons Dbutils | 
[commons-dbutils](https://github.com/apache/commons-dbutils) | 
[commons-dbutils](https://commons.apache.org/proper/commons-dbutils) |
-| Apache Commons Digester | 
[commons-digester](https://github.com/apache/commons-digester) | 
[commons-digester](https://commons.apache.org/proper/commons-digester) |
-| Apache Commons Email | 
[commons-email](https://github.com/apache/commons-email) | 
[commons-email](https://commons.apache.org/proper/commons-email) |
-| Apache Commons Exec | [commons-exec](https://github.com/apache/commons-exec) 
| [commons-exec](https://commons.apache.org/proper/commons-exec) |
-| Apache Commons Fileupload | 
[commons-fileupload](https://github.com/apache/commons-fileupload) | 
[commons-fileupload](https://commons.apache.org/proper/commons-fileupload) |
-| Apache Commons Functor | 
[commons-functor](https://github.com/apache/commons-functor) | 
[commons-functor](https://commons.apache.org/proper/commons-functor) |
-| Apache Commons Geometry | 
[commons-geometry](https://github.com/apache/commons-geometry) | 
[commons-geometry](https://commons.apache.org/proper/commons-geometry) |
-| Apache Commons Graph | 
[commons-graph](https://github.com/apache/commons-graph) | 
[commons-graph](https://commons.apache.org/proper/commons-graph) |
-| Apache Commons Imaging | 
[commons-imaging](https://github.com/apache/commons-imaging) | 
[commons-imaging](https://commons.apache.org/proper/commons-imaging) |
-| Apache Commons IO | [commons-io](https://github.com/apache/commons-io) | 
[commons-io](https://commons.apache.org/proper/commons-io) |
-| Apache Commons JCI | [commons-jci](https://github.com/apache/commons-jci) | 
[commons-jci](https://commons.apache.org/proper/commons-jci) |
-| Apache Commons JCS | [commons-jcs](https://github.com/apache/commons-jcs) | 
[commons-jcs](https://commons.apache.org/proper/commons-jcs) |
-| Apache Commons Jelly | 
[commons-jelly](https://github.com/apache/commons-jelly) | 
[commons-jelly](https://commons.apache.org/proper/commons-jelly) |
-| Apache Commons Jexl | [commons-jexl](https://github.com/apache/commons-jexl) 
| [commons-jexl](https://commons.apache.org/proper/commons-jexl) |
-| Apache Commons Jxpath | 
[commons-jxpath](https://github.com/apache/commons-jxpath) | 
[commons-jxpath](https://commons.apache.org/proper/commons-jxpath) |
-| Apache Commons Lang | [commons-lang](https://github.com/apache/commons-lang) 
| [commons-lang](https://commons.apache.org/proper/commons-lang) |
-| Apache Commons Logging | 
[commons-logging](https://github.com/apache/commons-logging) | 
[commons-logging](https://commons.apache.org/proper/commons-logging) |
-| Apache Commons Math | [commons-math](https://github.com/apache/commons-math) 
| [commons-math](https://commons.apache.org/proper/commons-math) |
-| Apache Commons Net | [commons-net](https://github.com/apache/commons-net) | 
[commons-net](https://commons.apache.org/proper/commons-net) |
-| Apache Commons Numbers | 
[commons-numbers](https://github.com/apache/commons-numbers) | 
[commons-numbers](https://commons.apache.org/proper/commons-numbers) |
-| Apache Commons Parent | 
[commons-parent](https://github.com/apache/commons-parent) | 
[commons-parent](https://commons.apache.org/proper/commons-parent) |
-| Apache Commons Pool | [commons-pool](https://github.com/apache/commons-pool) 
| [commons-pool](https://commons.apache.org/proper/commons-pool) |
-| Apache Commons Proxy | 
[commons-proxy](https://github.com/apache/commons-proxy) | 
[commons-proxy](https://commons.apache.org/proper/commons-proxy) |
-| Apache Commons RDF | [commons-rdf](https://github.com/apache/commons-rdf) | 
[commons-rdf](https://commons.apache.org/proper/commons-rdf) |
-| Apache Commons Release-plugin | 
[commons-release-plugin](https://github.com/apache/commons-release-plugin) | 
[commons-release-plugin](https://commons.apache.org/proper/commons-release-plugin)
 |
-| Apache Commons Rng | [commons-rng](https://github.com/apache/commons-rng) | 
[commons-rng](https://commons.apache.org/proper/commons-rng) |
-| Apache Commons Scxml | 
[commons-scxml](https://github.com/apache/commons-scxml) | 
[commons-scxml](https://commons.apache.org/proper/commons-scxml) |
-| Apache Commons Signing | 
[commons-signing](https://github.com/apache/commons-signing) | 
[commons-signing](https://commons.apache.org/proper/commons-signing) |
-| Apache Commons Skin | [commons-skin](https://github.com/apache/commons-skin) 
| [commons-skin](https://commons.apache.org/proper/commons-skin) |
-| Apache Commons Statistics | 
[commons-statistics](https://github.com/apache/commons-statistics) | 
[commons-statistics](https://commons.apache.org/proper/commons-statistics) |
-| Apache Commons Testing | 
[commons-testing](https://github.com/apache/commons-testing) | 
[commons-testing](https://commons.apache.org/proper/commons-testing) |
-| Apache Commons Text | [commons-text](https://github.com/apache/commons-text) 
| [commons-text](https://commons.apache.org/proper/commons-text) |
-| Apache Commons Validator | 
[commons-validator](https://github.com/apache/commons-validator) | 
[commons-validator](https://commons.apache.org/proper/commons-validator) |
-| Apache Commons VFS | [commons-vfs](https://github.com/apache/commons-vfs) | 
[commons-vfs](https://commons.apache.org/proper/commons-vfs) |
-| Apache Commons Weaver | 
[commons-weaver](https://github.com/apache/commons-weaver) | 
[commons-weaver](https://commons.apache.org/proper/commons-weaver) |
+Please see the [list of components](https://commons.apache.org/components.html)

(commons-dbutils) branch master updated: Update using current templates

Reply via email to