git.iko.soy/rowtype-yoga/package-sets
on master help sign in
Clarify when to add a new group line to packages.dhall (#308)

commit71a7e92d9fb65afdad97bb0fea6da58c5319e2be authorAdrian Sieber <36796532+ad-si@users.noreply.github.com> dateMon 13 May 2019, 15:10 (7 years ago) parent180014f
1 file changed+12−1
CONTRIBUTING.md+12−1
CONTRIBUTING.md+12−1
@@ -70,6 +70,7 @@ The following section will detail how to add a package to the package-set.
7070
7171The *TL;DR* about it is:
7272- add the Dhall package definition in some `src/groups/${username}.dhall` (where `username` is the one of the author of the package)
73+- if adding a new group file, also add a new line containing `⫽ ./groups/${username}.dhall` to `src/packages.dhall`
7374- run `make setup` and `psc-package verify ${your-new-package-name}`
7475
7576### 0. Background knowledge
@@ -167,6 +168,16 @@ in { unicorns =
167168 }
168169```
169170
171+Then add a new line containing a reference to the new group to the `src/packages.dhall` file.
172+
173+For our example:
174+
175+```hs
176+…
177+ ⫽ ./groups/someauthor.dhall
178+…
179+```
180+
170181
171182### 2. Verifying a package
172183
@@ -176,7 +187,7 @@ In order to verify the addition (or change), you should follow these steps:
176187- `make setup`: this will setup a test project based on the new package-set
177188- `psc-package verify ${your-new-package-name}`
178189
179−Once it verifies correctly, you should check in both the Dhall files and the `packages.json`
190+Once it verifies correctly check in both the Dhall files and the `packages.json` file.
180191
181192You're now ready to commit! 🙂
182193