mirror of
https://github.com/simonmichael/hledger.git
synced 2024-12-28 21:02:04 +03:00
docs: wish reporting guidance
This commit is contained in:
parent
54f0e2a288
commit
8956770c29
51
DEVELOP.md
51
DEVELOP.md
@ -4,7 +4,7 @@ title: hledger Developer Guide
|
||||
|
||||
# Developer guide
|
||||
|
||||
## Quick links
|
||||
**Quick links:**
|
||||
|
||||
**hledger released version**<br>
|
||||
[release notes](NEWS.html),
|
||||
@ -20,7 +20,7 @@ title: hledger Developer Guide
|
||||
packages
|
||||
|
||||
**hledger development version**<br>
|
||||
[Get it](#how-to-set-up-for-hledger-development),
|
||||
[Get it](#how-to-set-up-for-development),
|
||||
[browse it](http://github.com/simonmichael/hledger),
|
||||
[changes](http://github.com/simonmichael/hledger/commits),
|
||||
[CHANGES!](http://starlogs.net/#simonmichael/hledger) (turn up your volume)
|
||||
@ -46,35 +46,38 @@ or
|
||||
/><input type="submit" value="search released API docs"
|
||||
/></span>
|
||||
</form>
|
||||
\
|
||||
|
||||
|
||||
## How to..
|
||||
|
||||
### how to report problems
|
||||
New contributors of all levels are most welcome.
|
||||
Here are some tips to help you get productive on the hledger project.
|
||||
|
||||
- check for related issues in the [bug tracker](http://hledger.org/bugs) or in the [mail list archive](http://hledger.org/list)
|
||||
- discuss/confirm the issue on irc or list
|
||||
- report new issues in the bug tracker
|
||||
<!-- - test and share problem journal snippets at paste . hledger.org -->
|
||||
### how to suggest enhancements
|
||||
|
||||
### how to help with testing
|
||||
Suggestions and feature requests are easy to make, less easy to
|
||||
research, and hard to implement. And, alas! We don't have a team of
|
||||
sleek, well-fed, idle coders standing by to implement everybody's
|
||||
wishes. (Please
|
||||
[help change that](#how-to-set-up-for-hledger-development)).
|
||||
|
||||
- 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](#how-to-run-the-tests)
|
||||
- discuss/report problems via irc/mail list/bug tracker
|
||||
Wishes *are* welcome feedback, but we don't want them to pile up and
|
||||
obscure bugs and other developer priorities, so we manage them with discussion
|
||||
and optionally as cards on a trello board.
|
||||
The current recommendation is
|
||||
|
||||
### how to help with bug tracking
|
||||
1. **discuss/research first**\
|
||||
Is your wish already on the [trello wishlist/planning board](http://hledger.org/trello)
|
||||
or [bug tracker](http://hledger.org/bugs) ?\
|
||||
Perhaps discuss it on [irc](irc://irc.freenode.net/#ledger), the [mail list](http://hledger.org/list) or trello ?
|
||||
|
||||
- get to know the [bug tracker](http://hledger.org/bugs) and its contents
|
||||
- research and update issues
|
||||
- some convenient url shortcuts:
|
||||
[`hledger.org/bugs`](http://hledger.org/bugs)
|
||||
[`hledger.org/bugs/new`](http://hledger.org/bugs/new)
|
||||
`hledger.org/bugs/N`
|
||||
2. **report wishes on trello, bugs in the bug tracker**\
|
||||
Is it a problem with the released and documented functionality ? report in the [bug tracker](http://hledger.org/bugs)\
|
||||
Is it a wish ? add a card on the [trello board](http://hledger.org/trello), if needed
|
||||
|
||||
3. **don't sweat it**\
|
||||
Or, do what you think best. If a wish does land in the bug tracker, it gets the WISH label.
|
||||
|
||||
### how to report problems
|
||||
|
||||
@ -102,7 +105,7 @@ or
|
||||
[`hledger.org/bugs/new`](http://hledger.org/bugs/new)
|
||||
`hledger.org/bugs/N`
|
||||
|
||||
### how to set up for hledger development
|
||||
### how to set up for development
|
||||
|
||||
1. get an up-to-date [ghc](http://haskell.org/ghc), at least 7.0 and preferably 7.6
|
||||
2. there's probably no need to install the [haskell platform](http://haskell.org/platform) now, but you could
|
||||
@ -139,7 +142,7 @@ or
|
||||
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.
|
||||
|
||||
### how to get your patch committed
|
||||
### how to get your changes accepted
|
||||
|
||||
Follow the usual github workflow:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user