simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-19 10:17:35 +03:00
Code Issues Projects Releases Wiki Activity
caa48b35c2
hledger/DEVELOPMENT.md
Simon Michael 0fac098c97 docs: note GNU Make requirement
2012-12-28 17:43:24 +00:00

11 KiB
Raw Blame History

title
hledger contributor guide

Contributor guide

Quick links

Support
IRC channel: irc.freenode.net/#ledger
Mail list: list.hledger.org
Bug tracker: bugs.hledger.org
Tips: how to get help

Released version
release notes, hledger-web demo
ready-to-run binaries
hledger, hledger-web, hledger-vty, hledger-chart, hledger-lib packages

Development version
Get it, browse it (or via darcsweb)


[developer notes](http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES.org), [haddock coverage](http://hledger.org/profs/haddock-coverage), [unit test coverage](http://hledger.org/profs/coverage/hpc_index_fun.html), [benchmark](http://hledger.org/profs/latest.bench), [stale dependencies](http://packdeps.haskellers.com/feed/?needle=hledger) reports
[browse dev API docs](http://hledger.org/api/frames.html) or

How to..

how to get help

how to report problems

how to help with testing

  • review and test our documentation and web presence
  • download and test the binaries on your platform
  • test installing via cabal
  • use the tools and test functionality, usability, browser compatibility, ui layout etc.
  • check that hledger test reports no failures
  • run the developer tests
  • discuss/report problems via irc/mail list/bug tracker

how to help with bug tracking

how to set up for hledger development

  1. get an up-to-date ghc, at least 7.0 and preferably 7.6
  2. there's probably no need to install the haskell platform now, but you could
  3. it's probably worth getting the latest and best cabal: cabal update; cabal install cabal-install
  4. get an up-to-date darcs, at least 2.x and preferably newer: use a binary package or cabal install darcs
  5. the hledger Makefile assumes GNU Make, so on some platforms you may need to spell "make" as "gmake"

  • get the hledger repo:

      darcs get --lazy http://hub.darcs.net/simon/hledger
  cd hledger

  • install packages required to build hledger and add-ons, or as many of them as possible:

      cabal update
  make install

    This will also try to cabal install development builds of the hledger executables, so ghc-pkg unregister those afterwards if you don't want that.

  • try building with make:

      make bin/hledgerdev

    This is usually quicker and simpler than fiddling with multiple cabal packages during development. Note this executable will not be as optimised as the normal cabal build, and has the "dev" suffix as a reminder of this.

  • try auto-building with sp:

      make auto

    You'll need to follow the instructions to install sp. This is how I do most hledger development. It will recompile whenever you save changes to source files.

  • test patch sending. Make a dummy change:

      echo >>README.markdown; darcs record README.markdown -a -m 'my test patch'

    send it to yourself:

      darcs send --to me@my.address

    and make sure you receive it. If not, your system may not be configured to send email from the command line. Try to fix that. As a last resort, you can darcs send -O and mail the resulting patch file to the list. Finally, clean up:

      darcs obliterate -p 'my test patch'

how to get your patch committed

  • send it
  • you should receive a reply shortly. If in doubt, follow up at any time.
  • respond to any code review feedback, submitting new patches if needed, until you receive a "patch applied" acknowledgement
  • to verify the patch is in the main repo: listen for it on irc or look for it in darcsweb

how to improve the documentation

  • get familiar with the website and documentation online, review and test
  • get familiar with the site/doc source files (see Makefile)
  • set up for hledger development
  • send patches with names prefixed with "doc: " (or "site: ")

how to run the tests

  • set up for hledger development
  • cabal install shelltestrunner
  • make test

how to add a test

  • identify what to test
  • choose the test type: unit ? functional ? benchmark ?
  • currently expected to pass or fail ?
  • figure out where it goes
  • write test, verify expected result
  • get it committed

how to fix a bug or add a feature

  • research, discuss, validate the issue/feature on irc/list/bug tracker
  • look for related tests, run the tests and check they are passing
  • add a test ?
  • develop a patch
  • include any related issue numbers in the patch name, eg: "fix for blah blah (#NNN)"
  • get it committed

how to become a contributor

how to do code review

  • watch for and read new patches on the mail list, irc, or darcs hub (feed)
  • set up for development and test new patches in your own repo
  • read the existing code docs and source
  • send feedback or discuss via irc or list

how to help with packaging

  • package hledger for linux distros, macports, etc.
  • develop mac/windows installers
  • find and assist distro packagers/installer developers

how to help with project management

  • clarify/update goals and principles
  • monitor, report on project progress and performance
  • research, compare and report on successful projects, related projects
  • identify collaboration opportunities
  • marketing, communication, outreach
  • release management, roadmap planning

Project overview

A rough overview/blueprint for the hledger project.

mission, principles, goals

The hledger project aims to produce:

  • a practical, accessible, dependable tool for end users
  • a useful library and toolbox for finance-minded haskell programmers
  • a successful, time-and-money-solvent project within a thriving ecosystem of financial software projects.

roles and activities

  • newcomer/potential user
  • user
  • library user
  • field tester
  • bug wrangler
  • support
  • documentor
  • qa
  • developer
  • packager
  • communicator
  • project manager

documentation

  • website
  • user manual
  • developer guide
  • code documentation: haddock
  • various developer reports
  • developer notes outline
  • blurbs: in cabal files, module headers, google project, repo message of the day..

quality assurance

  • unit tests (HUnit, make unittest)
  • functional tests (shelltestrunner, make functest)
  • performance tests (simplebench, make bench)
  • documentation tests (make haddocktest + manual)
  • ui tests (manual)
  • installation tests (manual)

code

  • the hledger repo is hosted on hub.darcs.net

Related projects