diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md new file mode 100644 index 00000000..e6e0289d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -0,0 +1,7 @@ +--- +name: "\U0001F41B Bug report" +--- + +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 255892ab..31ffbe7d 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 spending time 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 99b9dc29..52c607f7 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 spending time suggesting 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 feature 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.