mirror of
https://github.com/jlengrand/helidon.git
synced 2026-03-10 08:21:17 +00:00
906111bcef
* New implementation of PublisherInputStream, now renamed to DataChunkInputStream. This new implementation fixes a couple of important problems: (1) It implements the ability to read into byte arrays, not just one byte at a time for better performance and (2) It changes the implementation to avoid a race condition when accessing the data chunks held in CompletableFuture's. The race condition resulted in certain tests to hang if a thread raced and updated the value of the old processed variable. There is also a new internal document docs-internal/datachunkinputstream.md that describes the new implementation. Signed-off-by: Santiago Pericasgeertsen <santiago.pericasgeertsen@oracle.com> * Fixed copyright header. Signed-off-by: Santiago Pericasgeertsen <santiago.pericasgeertsen@oracle.com>
Internal Documents and Specifications
This directory contains internal documents and specifications. These fall into a number of categories:
- Guidelines and best practices
- Design documents
- Feature proposals
- Or pretty much anything else
By keeping our documents as source code we can easily find them and easily review them.
Specs vs GitHub Issues
In many cases GitHub issues are sufficient for tracking requirements and basic proposals. But a spec might be more appropriate if you want an easy to review, living document with a fair amount of detail.
Use Markdown
Write your specs in Markdown. AsciiDoc is also OK if you need it.