From 7dd90329561f5c6f7553962f75d142b91fb7dc50 Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Mon, 3 Jul 2023 14:01:45 +0200 Subject: [PATCH 1/4] Update maintenance note --- .github/ISSUE_TEMPLATE/---bug-report.md | 7 +++++++ CONTRIBUTING.md | 3 +++ README.md | 15 ++++++--------- 3 files changed, 16 insertions(+), 9 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/---bug-report.md diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md new file mode 100644 index 000000000..f00ff415a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -0,0 +1,7 @@ +--- +name: "\U0001F41B Bug report" +--- + +This library is considered "complete", please view bugs you might identify rather as features, or maybe as wrinkels of worn code. + +See [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 255892ab2..c0ef6a88e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,8 @@ # Submitting pull requests +**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before investing time in suggesting changes to this library.** + + Pull requests should go via GitHub; there are some nice [general guidelines for contributing on GitHub](https://guides.github.com/activities/contributing-to-open-source/) if you haven't done it before. diff --git a/README.md b/README.md index 99b9dc29d..39567c569 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,8 @@ -Configuration library for JVM languages. +# Configuration library for JVM languages. [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.typesafe/config/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.typesafe/config) [![Build Status](https://github.com/lightbend/config/actions/workflows/ci.yml/badge.svg)](https://github.com/lightbend/config/actions/workflows/ci.yml) -If you have questions or are working on a pull request or just -curious, please feel welcome to join the chat room: -[![Join chat https://gitter.im/lightbend/config](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lightbend/config?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - ## Overview - implemented in plain Java with no dependencies @@ -98,8 +94,7 @@ to merge it in. ### Binary Releases -Version 1.2.1 and earlier were built for Java 6, while newer -versions (1.3.0 and above) will be built for Java 8. +Typesafe Config is compatible with Java 8 and above. You can find published releases on Maven Central. @@ -133,6 +128,8 @@ https://github.com/lightbend/config/blob/main/NEWS.md ### Bugs and Patches +**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before investing time to suggest changes to this library.** + Report bugs to the GitHub issue tracker. Send patches as pull requests on GitHub. @@ -949,6 +946,6 @@ The license is Apache 2.0, see LICENSE-2.0.txt. ## Maintained by -This project is maintained mostly by [@havocp](https://github.com/havocp) and [@akka-team](https://github.com/orgs/lightbend/teams/akka-team/members). +The "Typesafe Config" library is an important foundation to how Akka and other JVM libraries manage configuration. We at [Lightbend](https://lightbend.com) consider the functionality of this library as complete. We will make sure "Typesafe Config" keeps up with future JVM versions, but will rarely make any other changes. -Feel free to ping above maintainers for code review or discussions. Pull requests are very welcome–thanks in advance! +We are thankful for all the work [@havocp](https://github.com/havocp) has put into creating the library initially and supporting its users over many more years, even after leaving Lightbend. From 0dcedf165ce7c1efb2c10ffaec8da11fc2af958c Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Tue, 4 Jul 2023 18:38:55 +0200 Subject: [PATCH 2/4] spelling Co-authored-by: Justin Pihony --- .github/ISSUE_TEMPLATE/---bug-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index f00ff415a..8df370391 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -2,6 +2,6 @@ name: "\U0001F41B Bug report" --- -This library is considered "complete", please view bugs you might identify rather as features, or maybe as wrinkels of worn code. +This library is considered "complete", please view bugs you might identify rather as features, or maybe as wrinkles of worn code. See [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) From 86ae02e65bb7e143b024d63f986c346c0a129daf Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Wed, 5 Jul 2023 10:04:19 +0200 Subject: [PATCH 3/4] Down to earth wording. --- .github/ISSUE_TEMPLATE/---bug-report.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index 8df370391..e6e0289de 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -2,6 +2,6 @@ name: "\U0001F41B Bug report" --- -This library is considered "complete", please view bugs you might identify rather as features, or maybe as wrinkles of worn code. +This library is considered feature complete. We will make sure "Typesafe Config" keeps up with future JVM versions, but will rarely make any other changes. See [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c0ef6a88e..31ffbe7dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Submitting pull requests -**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before investing time in suggesting changes to this library.** +**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before spending time suggesting changes to this library.** Pull requests should go via GitHub; there are some nice diff --git a/README.md b/README.md index 39567c569..228381f24 100644 --- a/README.md +++ b/README.md @@ -946,6 +946,6 @@ The license is Apache 2.0, see LICENSE-2.0.txt. ## Maintained by -The "Typesafe Config" library is an important foundation to how Akka and other JVM libraries manage configuration. We at [Lightbend](https://lightbend.com) consider the functionality of this library as complete. We will make sure "Typesafe Config" keeps up with future JVM versions, but will rarely make any other changes. +The "Typesafe Config" library is an important foundation to how Akka and other JVM libraries manage configuration. We at [Lightbend](https://lightbend.com) consider the functionality of this library as feature complete. We will make sure "Typesafe Config" keeps up with future JVM versions, but will rarely make any other changes. We are thankful for all the work [@havocp](https://github.com/havocp) has put into creating the library initially and supporting its users over many more years, even after leaving Lightbend. From fcf7832917906e8b50a18d11eccb1f1770070e9d Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Wed, 5 Jul 2023 10:07:53 +0200 Subject: [PATCH 4/4] More idiomatic --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 228381f24..52c607f76 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ https://github.com/lightbend/config/blob/main/NEWS.md ### Bugs and Patches -**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before investing time to suggest changes to this library.** +**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before spending time suggesting changes to this library.** Report bugs to the GitHub issue tracker. Send patches as pull requests on GitHub.