Skip to content

Commit 033b078

Browse files
committed
documentation: Add contribution instructions.
1 parent cb7b6c9 commit 033b078

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to `dataframe`
22

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.
44

55
## Table of Contents
66

@@ -43,10 +43,13 @@ You can contribute in many ways:
4343
* Prefer total functions and avoid partial ones unless necessary (with clear documentation).
4444
* Use strict folds when applicable to avoid space leaks.
4545
* 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!
4747
* Code is formatted with Fourmolu. Both HLint and Fourmolu run in CI and must pass.
4848
4. **Testing**
4949
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`
5053
5154
## Documentation
5255
@@ -70,6 +73,7 @@ Feature suggestions are welcome too! Bonus points for a motivating use case.
7073
* Push to your fork and open a PR.
7174

7275
Please include:
76+
* A tag (usually `feat`, `documentation`, `refactor` etc).
7377
* A description of the problem and solution.
7478
* Benchmarks or reasoning if the change impacts performance.
7579
* Tests and documentation where applicable.

0 commit comments

Comments
 (0)