Skip to content

Commit 40e5d05

Browse files
authored
Update maintenance note (#788)
1 parent 6e035f2 commit 40e5d05

File tree

3 files changed

+16
-9
lines changed

3 files changed

+16
-9
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
---
4+
5+
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.
6+
7+
See [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by)

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Submitting pull requests
22

3+
**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before spending time suggesting changes to this library.**
4+
5+
36
Pull requests should go via GitHub; there are some nice
47
[general guidelines for contributing on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
58
if you haven't done it before.

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
Configuration library for JVM languages.
1+
# Configuration library for JVM languages.
22

33
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.typesafe/config/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.typesafe/config)
44
[![Build Status](https://github.com/lightbend/config/actions/workflows/ci.yml/badge.svg)](https://github.com/lightbend/config/actions/workflows/ci.yml)
55

6-
If you have questions or are working on a pull request or just
7-
curious, please feel welcome to join the chat room:
8-
[![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)
9-
106
## Overview
117

128
- implemented in plain Java with no dependencies
@@ -98,8 +94,7 @@ to merge it in.
9894

9995
### Binary Releases
10096

101-
Version 1.2.1 and earlier were built for Java 6, while newer
102-
versions (1.3.0 and above) will be built for Java 8.
97+
Typesafe Config is compatible with Java 8 and above.
10398

10499
You can find published releases on Maven Central.
105100

@@ -133,6 +128,8 @@ https://github.com/lightbend/config/blob/main/NEWS.md
133128

134129
### Bugs and Patches
135130

131+
**NOTE: Please read [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by) before spending time suggesting changes to this library.**
132+
136133
Report bugs to the GitHub issue tracker. Send patches as pull
137134
requests on GitHub.
138135

@@ -949,6 +946,6 @@ The license is Apache 2.0, see LICENSE-2.0.txt.
949946

950947
## Maintained by
951948

952-
This project is maintained mostly by [@havocp](https://github.com/havocp) and [@akka-team](https://github.com/orgs/lightbend/teams/akka-team/members).
949+
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.
953950

954-
Feel free to ping above maintainers for code review or discussions. Pull requests are very welcome–thanks in advance!
951+
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.

0 commit comments

Comments
 (0)