You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to `dataframe`
2
2
3
-
Thank you for your interest in contributing to **hsky**, a Haskell dataframe library built for speed, clarity, and expressive data analysis. Contributions are welcome and encouraged! This guide will walk you through how to get started.
3
+
Thank you for your interest in contributing to **dataframe**, a Haskell dataframe library built for speed, clarity, and expressive data analysis. Contributions are welcome and encouraged! This guide will walk you through how to get started.
4
4
5
5
## Table of Contents
6
6
@@ -43,10 +43,13 @@ You can contribute in many ways:
43
43
* Prefer total functions and avoid partial ones unless necessary (with clear documentation).
44
44
* Use strict folds when applicable to avoid space leaks.
45
45
* Maintain performance discipline: avoid unnecessary allocations or intermediate structures.
46
-
* Please run `./scripts/format.sh` and `./scripts/lint.sh` (or `./scripts/lint.sh --fix`) before submitting your code!
46
+
* Please run `./scripts/presubmit.sh` (or `./scripts/lint.sh --fix`) before submitting your code!
47
47
* Code is formatted with Fourmolu. Both HLint and Fourmolu run in CI and must pass.
48
48
4. **Testing**
49
49
We use HUnit and QuickCheck for unit and property-based tests. Add tests for new features under `test/`. If you're fixing a bug, add a test that fails without your fix.
50
+
* To test a change in the REPL run:
51
+
* `./script/repl.sh`
52
+
* Then in the terminal run `:script dataframe.ghci`
50
53
51
54
## Documentation
52
55
@@ -70,6 +73,7 @@ Feature suggestions are welcome too! Bonus points for a motivating use case.
70
73
* Push to your fork and open a PR.
71
74
72
75
Please include:
76
+
* A tag (usually `feat`, `documentation`, `refactor` etc).
73
77
* A description of the problem and solution.
74
78
* Benchmarks or reasoning if the change impacts performance.
0 commit comments