clojure / clojure/clojure-site
Write a "learn" page or a guide on IO
Open
Nobody has claimed this yet.
content
help wanted
- Dominant language
- HTML
- Stars
- 259
- Forks
- 275
- PR merge metrics
- No merged PRs in 30d
Description
This is a place where Clojure relies heavily on Java and having an overview of that would be very helpful
- streams vs reader/writers
- buffered and other kinds of readers
- charsets
- stdin/stdout/stderr
- slurp/spit
- clojure.java.io
- using read, read-line, read-string
- printing is probably a separate page/guide and we have a ticket for that, but maybe just a bit would be useful
- the role of edn
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by organizing the requested topics around Clojure's Java I/O relationship, including streams, readers and writers, buffering, charsets, standard streams, slurp/spit, clojure.java.io, and the read functions. Check the existing learn material and the separate printing ticket before deciding the guide's scope. Done means a coherent overview that also explains the role of EDN.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure, java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100