CrystalSplitter/ghcitui
1
1
Fork 0
mirror of https://github.com/CrystalSplitter/ghcitui.git synced 2024-08-16 14:40:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add section on profiling in CONTRIBUTING.md

Browse Source
This commit is contained in:
CrystalSplitter 2024-01-10 22:47:05 -08:00 committed by Jordan R AW
parent bf93aeecda
commit c6bebb787f
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -19,6 +19,15 @@ Though there are some notable diverges, some of which are listed below.
- Try to limit lines to 100 characters, but no _hard_ limit.
- Let the auto-formatter handle spacing/alignment.
## Profiling
GHCiTUI has some fairly strict runtime requirements, as it needs to have a
snappy response time to events. Therefore, it's important to profile
large changes and report on that profiling.
The `profiteur` tool (https://github.com/jaspervdj/profiteur) does an
excellent job of visualising these profiles.
# Contributor Covenant Code of Conduct
## Our Pledge