Skip to content

Commit e362f5c

Browse files
jamesmckinnaandreasabel
authored andcommitted
Update HACKING (#2242)
* added paragraph on coupled contributions * typo
1 parent d3521b6 commit e362f5c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

HACKING.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ What is an acceptable contribution?
2727
In general, if something is in a general undergraduate Computer Science or Mathematics
2828
textbook it is probably (!) contributable.
2929

30+
Note on contributions to related/'coupled' modules
31+
==================================================
32+
33+
Before making changes to a `Data` module please have a look at related modules
34+
and see if they have any content along similar lines. If so, then please
35+
follow those conventions (e.g. naming, argument order).
36+
For example, if working on `Data.Rational`, please check `Data.Rational.Unnormalised`
37+
or if working on `Data.Vec` please check `Data.List` and vice versa.
38+
Likewise, if adding to such modules, please try to make companion additions
39+
to the related ones, or at least to make a task-list in the comments on your PR,
40+
indicating what outstanding work may be left for subsequent contributions/contributors.
41+
3042
Setup
3143
=====
3244

@@ -110,9 +122,9 @@ git checkout master
110122
git pull
111123
```
112124

113-
The second step is to create a branch for that feature based off of `master`.
125+
The second step is to create a branch for that feature based off `master`.
114126
Make sure to pick a fresh name in place of `new_feature`. We promptly push
115-
this new branch to our fork using the `-u` option fo `push`.
127+
this new branch to our fork using the `-u` option for `push`.
116128

117129
```shell
118130
git checkout -b new_feature

0 commit comments

Comments
 (0)