hledger/doc/ISSUES.md

27 KiB

Issues

The hledger project's issue tracker is on github. It contains:

  • BUG issues - failures in some part of the hledger project (the main hledger packages, docs, website..)
  • WISH issues - feature proposals, enhancement requests
  • uncategorised issues - we don't know what these are yet
  • pull requests - proposed changes to code and docs

Quick urls

Open issues

COMPONENT/TOPIC BUGS WISHES PRS OTHER
all bugs wishes PRs other
Tools:
install (hledger-install.sh) bugs wishes PRs other
cli (hledger) bugs wishes PRs other
ui (hledger-ui) bugs wishes PRs other
web (hledger-web) bugs wishes PRs other
Input/Output Formats:
journal bugs wishes PRs other
timeclock bugs wishes PRs other
timedot bugs wishes PRs other
csv bugs wishes PRs other
json bugs wishes PRs other
html bugs wishes PRs other
Commands:
accounts bugs wishes PRs other
activity bugs wishes PRs other
add bugs wishes PRs other
balcmds (bal/bs/bse/cf/is/...) bugs wishes PRs other
balance bugs wishes PRs other
balancesheet bugs wishes PRs other
cashflow bugs wishes PRs other
close bugs wishes PRs other
import bugs wishes PRs other
incomestatement bugs wishes PRs other
prices bugs wishes PRs other
print bugs wishes PRs other
register bugs wishes PRs other
rewrite bugs wishes PRs other
roi bugs wishes PRs other
stats bugs wishes PRs other
tags bugs wishes PRs other
Miscellaneous:
budget (budgeting) bugs wishes PRs other
packaging (packaging, dependencies) bugs wishes PRs other
doc (documentation, help) bugs wishes PRs other
periodexpressions (-b, -e, -p, date:) bugs wishes PRs other
site (website, web presence) bugs wishes PRs other
tools (dev tools, infrastructure) bugs wishes PRs other

Some loose conventions:

  • In bug titles, mention the hledger version in which the bug first appeared (and avoid mentioning version numbers otherwise). This allows searches like new issues in 1.22 and regressions in 1.22

Labels

https://github.com/simonmichael/hledger/labels, also listed at open issues above, are used to categorise:

  • whether an issue is a bug (red) or a wish (pink)
  • related subcomponents (tools, commands, input/output formats) (light blue)
  • related general topics (light green)
  • related platforms (light purple)
  • whether a bounty has been offered (dark green)
  • why an issue is blocked (dark grey) or was closed (black)
  • low priority info, like "imported" (white)

Labels can also be used as prefixes in issue/PR titles, as prefixes in commit messages, etc.

Custodians

If you are interested in helping with a particular component for a while, please add yourself as a custodian in Open Issues table above. A custodian's job is to help manage the issues, rally the troops, and drive the open issue count towards zero. The more custodians, the better! By dividing up the work this way, we can scale and make forward progress.

Milestones and Projects

Milestones are used a little bit to plan releases. In 2017 we experimented with projects, but in 2018 milestones are in favour again..

Estimates

You might see some experiments in estimate tracking, where some issue names might have a suffix noting estimated and spent time. Basic format:

ESTIMATEDTOTALTASKTIME\|TIMESPENTSOFAR

hours estimated, no time spent [..] half an hour estimated (a dot is ~a quarter hour, as in timedot format) [1d] one day estimated (a day is ~4 hours) [1w] one week estimated (a week is ~5 days or ~20 hours) [3|2] three hours estimated, about two hours spent so far

1\|1w\|2d

two days spent so far ``` Estimates are always for the total time cost (not time remaining). Estimates are not usually changed, a new estimate is added instead. Numbers are very approximate, but better than nothing.

Trello

The trello board (trello.hledger.org) is an old collection of wishlist items. This should probably be considered deprecated.