hledger/ROADMAP.md
Simon Michael e66e68ed86 ;doc: roadmap: doc milestones
[ci skip]
2019-10-27 08:06:50 -07:00

2.7 KiB

Roadmap / Wishlist

Ideas about where the hledger project should be going next, as of 2019q4. Discussion welcome.

Targets

Dated targets we are aiming for:

  • hledger 1.16 - 2019-12-01
    • ghc 8.8 support
    • updated home page, faq, manuals
    • basic bar charts
    • reduce install hassles with terminfo C lib

Priorities

Current priorities for the project, grouped under four overarching themes:

Documentation

Improving the docs.

  • home & faq
  • manuals (more discoverability on web)
  • contrib guide (include readmes, update)
  • cookbook docs (survey, plan, update)

"Effectiveness"

Improving approachability, just-works quality, practicality, real-world usefulness.

  • ghc 8.8, stackage nightly
  • install issues (C libs..)
  • more powerful CSV conversion
  • fill out holes in feature matrix

Charts

Adding charts and more visual appeal.

  • console charts, basic bar charts
  • clarify architecture/UI for charts
  • graphical charts using Chart and/or Vega
  • review/design/add more attractive default output (see taskwarrior)

Investment

Improving suitability for investment tracking. #1015

  • easy price fetching
  • lots
  • capital gains
  • ?

Wishlist

A few high-level maintainer wishes, by topic. Discussing/moving any of these forward is a big help.

Docs

  • build the contributor/dev guide from CONTRIBUTING.md plus the READMEs; clean up
  • move general PTA docs to plaintextaccounting.org
  • simplify manuals' TOC/structure on the website

Tests

  • migrate to tasty, unblock ghc 8.8 support
  • survey/document current testing setup (process, coverage, redundancy..); identify weaknesses; design a policy for tests; make a plan for achieving that
  • start adding property tests/other new kinds of testing if appropriate

Milestones

Some project achievements to unlock, for fun:

  • 1.0 release
  • packaged in major distros, binaries available
  • pretty good reference docs
  • 100 committers
  • 1k github stars
  • among top 50 haskell projects by github stars
  • discussed on Hacker News
  • match ledger IRC channel
  • multiple people providing support
  • pretty good tutorial docs
  • mentioned in "what good Haskell software exists" discussions
  • pretty good cookbook docs
  • 100 IRC chatters
  • 2k github stars
  • among top 40 haskell projects by github stars
  • match ledger speed
  • match ledger committers
  • 200 committers
  • 2.0 release
  • match ledger stars
  • match beancount mail list
  • match ledger mail list