From e5988a163644dcdd9abde07a2c53392e44ad63b3 Mon Sep 17 00:00:00 2001 From: Nate Jensen Date: Fri, 30 Jul 2021 23:25:25 -0500 Subject: [PATCH] update release notes, readme, contributing guide --- .github/CONTRIBUTING.md | 18 +++++++++++------- README.rst | 10 ++++++++-- release_notes/4.0-notes.rst | 5 +++++ 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4554128f..c66c79ac 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,16 +5,20 @@ Testing the build of Jep on the variety of possible platforms and environments is difficult. It works well for Linux and OS X. Building on Windows poses unique challenges that have been documented on the [Windows wiki page](https://github.com/mrj0/jep/wiki/Windows). -If your environment has build problems please search for a solution and post -your results to the mailing list so it is documented for others with a similar -environment. +Please consider documenting build troubles and solutions on the wiki to help +others. -## Reporting issues +## Seeking help + +If you need help using Jep, please first search for existing issues, questions, +and documentation to see if your question has already been answered. If you +can't find the solution, you may open an issue to ask questions. Please be +detailed with information surrounding your problem. Please close the issue +once the issue is solved to keep down the number of open issues. -Please only report issues that you believe are bugs or feature requests. -Questions about Jep should be directed to the -[mailing list](https://groups.google.com/forum/#!forum/jep-project). + +## Reporting issues When reporting bugs please include the Python version, Java version, and operating system. It is also helpful if you can recreate or simulate the diff --git a/README.rst b/README.rst index 676ed87e..3db76907 100644 --- a/README.rst +++ b/README.rst @@ -58,11 +58,17 @@ Help ---- * `Documentation `_ * `JavaDoc `_ -* `Mailing List `_ -* `Known Issues `_ +* `Mailing List (deprecated) `_ +* `Known Issues and Help `_ * `Contribution Guidelines `_ * `Project Page `_ We welcome comments, contributions, bug reports, wiki documentation, etc. +If you need help, please first search for existing solutions online, in the +the issues, and on the wiki. If you still need help, please open a GitHub issue +and we will try and help you. Please remember to close the issue once it has +been resolved. + + *Jep Team* diff --git a/release_notes/4.0-notes.rst b/release_notes/4.0-notes.rst index 32d8d514..7da64019 100644 --- a/release_notes/4.0-notes.rst +++ b/release_notes/4.0-notes.rst @@ -42,6 +42,11 @@ Python buffer objects can be converted to Java arrays Python buffer objects such as bytes, bytearray and array.array can be converted to java primitive arrays when they are passed from Python to Java. +Redirect streams now supports OutputStreams +******************************************* +The redirect streams capability now takes an OutputStream instead of +automatically redirecting to Java's System.out or System.err. + Internal cleanup and Improvements ********************************* Minor bug fixes, spelling fixes, warning silencing, build compatibility