From a38de9528197b2d01e5b6c9b2e0af3a624cff017 Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Fri, 24 Jan 2025 14:04:12 +0000 Subject: [PATCH 1/3] Prepare for the next release candidate --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 2155767052..36756fe513 100644 --- a/pom.xml +++ b/pom.xml @@ -28,7 +28,7 @@ limitations under the License. commons-codec commons-codec - 1.18.0-SNAPSHOT + 1.18.0 Apache Commons Codec 2002 @@ -100,7 +100,7 @@ limitations under the License. true scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid} - 2025-01-06T22:01:21Z + 2025-01-24T14:02:30Z 0.8.12 3.2.5 From 5f76abb946164b943bc2cf367bc1d70b8f6e70d1 Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Mon, 27 Jan 2025 09:14:30 -0500 Subject: [PATCH 2/3] Update contributing file from user feedback --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af64786272..1b6577ae46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,18 +60,21 @@ 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. `CODEC-123-InputStream`. + * Usually you should base your branch from the `master` branch. + * A good topic branch name can be the JIRA bug ID plus a keyword, for example, `CODEC-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. `CODEC-123: Close input stream earlier` + * For example, `[CODEC-123] Close input stream earlier` + Respect the original code style: - + Only use spaces for indentation. + + Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing. + 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 ensure nothing else was accidentally broken. ++ Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best-practice. +Unit tests are typically in the `src/test/java` directory. ++ Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself. ++ Write a pull request description that is detailed enough to understand what the pull request does, how, and why. ++ Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge. + Making Trivial Changes ---------------------- @@ -79,7 +82,7 @@ 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. +In this case, it is appropriate to start the first line of a commit with '[doc]' or '[javadoc]' instead of a ticket number. Submitting Changes From 5caa0ca30068298a8242955976cfbc7edacc278b Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Mon, 27 Jan 2025 18:06:07 +0000 Subject: [PATCH 3/3] Bump to next development version --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 36756fe513..c846589b5f 100644 --- a/pom.xml +++ b/pom.xml @@ -28,7 +28,7 @@ limitations under the License. commons-codec commons-codec - 1.18.0 + 1.18.1-SNAPSHOT Apache Commons Codec 2002 @@ -100,7 +100,7 @@ limitations under the License. true scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid} - 2025-01-24T14:02:30Z + 2025-01-27T18:05:48Z 0.8.12 3.2.5