Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update maintenance note #788

Merged
merged 4 commits into from
Jul 6, 2023
Merged

Update maintenance note #788

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7dd9032
Update maintenance note
ennru Jul 3, 2023
0dcedf1
spelling
ennru Jul 4, 2023
86ae02e
Down to earth wording.
ennru Jul 5, 2023
fcf7832
More idiomatic
ennru Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/---bug-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
ennru marked this conversation as resolved.
Show resolved Hide resolved

See [Readme #Maintained-by](https://github.com/lightbend/config#Maintained-by)
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.**
ennru marked this conversation as resolved.
Show resolved Hide resolved


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.
Expand Down
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.**
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

Report bugs to the GitHub issue tracker. Send patches as pull
requests on GitHub.

Expand Down Expand Up @@ -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.