Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Write a "learn" page or a guide on IO

Open
#576 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
clojure, java
Domain
documentation

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.

Description

content help wanted

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
Dominant language
HTML
Stars
259
Forks
275
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from clojure/clojure-site

All issues in clojure/clojure-site

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.