Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update HACKING #2242

Merged
merged 2 commits into from
Jan 1, 2024
Merged

Update HACKING #2242

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cef4ea1
added paragraph on coupled contributions
jamesmckinna Dec 31, 2023
e1d1727
typo
jamesmckinna Dec 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,18 @@ What is an acceptable contribution?
In general, if something is in a general undergraduate Computer Science or Mathematics
textbook it is probably (!) contributable.

Note on contributions to related/'coupled' modules
==================================================

Before making changes to a `Data` module please have a look at related modules
and see if they have any content along similar lines. If so, then please
follow those conventions (e.g. naming, argument order).
For example, if working on `Data.Rational`, please check `Data.Rational.Unnormalised`
or if working on `Data.Vec` please check `Data.List` and vice versa.
Likewise, if adding to such modules, please try to make companion additions
to the related ones, or at least to make a task-list in the comments on your PR,
indicating what outstanding work may be left for subsequent contributions/contributors.

Setup
=====

Expand Down Expand Up @@ -110,9 +122,9 @@ git checkout master
git pull
```

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

```shell
git checkout -b new_feature
Expand Down