Skip to content

Commit

Permalink
update release notes, readme, contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ndjensen committed Jul 31, 2021
1 parent f67b874 commit e5988a1
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 9 deletions.
18 changes: 11 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,17 @@ Help
----
* `Documentation <https://github.com/ninia/jep/wiki>`_
* `JavaDoc <https://ninia.github.io/jep/javadoc>`_
* `Mailing List <https://groups.google.com/d/forum/jep-project>`_
* `Known Issues <https://github.com/ninia/jep/issues>`_
* `Mailing List (deprecated) <https://groups.google.com/d/forum/jep-project>`_
* `Known Issues and Help <https://github.com/ninia/jep/issues>`_
* `Contribution Guidelines <https://github.com/ninia/jep/blob/master/.github/CONTRIBUTING.md>`_
* `Project Page <https://github.com/ninia/jep>`_

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*
5 changes: 5 additions & 0 deletions release_notes/4.0-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e5988a1

Please sign in to comment.