jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-11-25 21:38:31 +03:00
Code Issues Projects Releases Wiki Activity

Add bug report section to README

Browse Source
This commit is contained in:
Jonathan Daugherty 2015-07-09 11:15:21 -07:00
parent 2e13a1cde5
commit 9e0c971309
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -57,6 +57,21 @@ The development of this library has also revealed some bugs in `vty`,
and I've tried to report those as I go. If they haven't been resolved,
you'll see them arise when using `brick`.
Reporting bugs
--------------
Please file bug reports as GitHub issues. For best results:
- Include the versions of relevant software packages: `brick`, `ghc`,
and `vty` will be the most important ones. Even better, the output
of `cabal freeze` would probably be helpful in making the problem
reproducible.
- Clearly describe the behavior you expected ...
- ... and include a mininal demonstration program that exhibits the
behavior you actually observed.
Contributing
------------