Skip to content

Commit 3da51ba

Browse files
Add broken folder's readme (#160)
1 parent 2ef6362 commit 3da51ba

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ A cookbook demonstrates how to do X. It does not explain why X works, the concep
7777
For context, this constraint is imposed on us by a limitation. Bundlers (e.g. `parcel`, `esbuild`) cannot find the corresponding `npm` dependency when bundling for the web backend. We fixed this by installing the npm dependency in the root folder's `package.json` file. This isn't ideal and we hope to find a solution that can remove this limitation in the future. However, this constraint will remain until such a solution is found.
7878

7979
Nonetheless, let's say Recipe A through Recipe Y use version 1 of the npm dependency, `foo`, and Recipe Z wants to use version 2 of `foo`. Let's assume Recipes A-Y already exist, and someone submitted a PR to add Recipe Z. Will such a PR be accepted? Yes, provided the following is done:
80-
- in Recipe Z's PR, move Recipes A-Y into the repo's "broken" folder (if the folder doesn't exist, create it)
80+
- in Recipe Z's PR, move Recipes A-Y into the repo's "broken" folder
8181
- in this repo, open an issue for Recipes A-Y so we know to fix it later
8282

8383
After CI passes and the following are done, we will merge the PR.

broken/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Broken
2+
3+
This folder stores recipes that worked/compiled at one time and then were later broken by one of the following:
4+
- a new PureScript release that includes breaking changes
5+
- a new package set release where one of the recipes' dependencies included breaking changes
6+
- a new package set release that dropped one of the recipes' dependencies
7+
8+
While these recipes may be "broken," it might not take much work to get them working again. So, consider updating them and then moving them back to the `recipes` folder or viewing these as unmaintained documentation.

0 commit comments

Comments
 (0)