Skip to content

Latest commit

 

History

History
138 lines (107 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

138 lines (107 loc) · 10.4 KB
Raw

Contributing new recipes

The instructions for adding a new recipe appear first with the rationale behind them appearing later. After that, we explain why we decided to use make as our build tool and provide a few resources to help developers get more familiar with it. Note: learning make isn't required to add a recipe. Those who are curious can learn more from this repo's example.

Instructions

Follow these instructions for contributing new recipes. The Goal headers indicate the outcome achieved by following them:

Goal 1: Claim and Start Working on a Recipe Request

  1. Search currently open "Recipe Request" issues.
  2. (optional) If your recipe idea is unique, open a new "Recipe Request" issue. This step aims to prevents two people from working on the same recipe.
  3. Proceed to the next step if you'd like to implement this recipe yourself.

Goal 2: Setup a New Recipe's Boilerplate by Copying a Current Similar One

  1. Pick an existing recipe to duplicate as a starting point. Here are some suggestions:

    Web Node CLI Framework Template
    ✔️ ✔️ HelloLog
    ✔️ ❌ ❌ GroceriesJs
    ❌ ✔️ ❌ ReadPrintFileContentsNode
    ❌ ✔️ ✔️ DiceCLI
    ✔️ Concur HelloConcur
    ✔️ Halogen HelloHalogenHooks
    ✔️ React HelloReactHooks

    Notes on interpreting the table:

    • An empty cell means "not possible".
    • Web - Recipe is compatible with the web browser backend.
    • Node - Recipe is compatible with the Node.js backend.
    • CLI - Recipe does not terminate, and/or requires user interaction (e.g. a CLI app) when run in the Node.js environment. These recipes contain a special configuration flag to prevent our CI process from stalling on these recipes during testing.
    • Framework - Recipe uses a particular web framework.
    • Template - A recommended recipe to copy.

  2. Run the recipe creation script. Substitute MyNewRecipe with your recipe name:

    ./scripts/newRecipe.sh MyNewRecipe HelloLog
    • Tip: You may point to the recipe path to take advantage of shell autocompletion 
      ./scripts/newRecipe.sh MyNewRecipe recipes/HelloLog
    • Tip: The make commands printed after running this script will be helpful when developing your recipe. Make a copy of these for reference.
    • Tip: If you made a typo, or decide you want to rename your recipe, you can simply re-run this script to create a new recipe from your misspelled one with the correction, then delete the misspelled recipe: 
      ./scripts/newRecipe.sh MyNewRecipeOops HelloLog

# *** Do lots of development work in the misspelled recipe ***

# Fix the typo
./scripts/newRecipe.sh MyNewRecipe MyNewRecipeOops
rm -r recipes/MyNewRecipeOops

Goal 3: Implement and Submit the Recipe

  1. Install all the tools (e.g. purescript, spago, parcel) used in this repo by running make installDeps.
  2. Install needed PureScript dependencies via spago.
    • Due to a bug in Spago (#654), follow these instructions:
      1. Change directory into your recipe folder: cd recipes/MyRecipeName
      2. Install dependencies as normal: spago install <packageName>
      3. Return to the root directory: cd ../..
    • Note: you can only install dependencies that exist in the latest package set release; you cannot add or override packages in packages.dhall (see Principles section for more context).
  3. Install needed npm dependencies via npm i <packageName>. These will be installed to the root folder's node_modules folder, not a corresponding folder in the recipe.
    • If you do install npm dependencies for your recipe, please state which libraries were installed in the recipe's README.md file.
    • You can commit and include with your PR the resulting update to package.json (you don't need to commit the package-lock.json, however)
    • If you want your recipe to be compatible with TryPureScript, the npm dependency must be listed here. If it's not listed, open a PR to add it to that file.
  4. Implement your recipe.
    • If you add any new modules, always start the module name with your recipe's "Unique Recipe Name" (e.g. MyNewRecipe.Foo, MyNewRecipe.Module.Path.To.Cool.Types).
      • Note: Your recipe will not be compatible with TryPureScript if it contains more than one module.
  5. Build and test your recipe.
    • The necessary commands to launch your recipe were printed after running scripts/newRecipe.sh. Hopefully you copied some of them. If not, you may consult these instructions on running recipes.
    • Note: make commands must be run from the cookbook's root directory.
    • Tip: If you'd like to automatically rebuild recipes after saving changes and your IDE is being uncooperative, you can run make MyNewRecipe-build-watch while in the root folder.
  6. Update your recipe's README.md file by doing the following things:
    1. Write a summary of your recipe on the 3rd line. This is what will appear in the repo's Recipe section's Table of Contents. Don't add newlines unless you're okay with that additional content being omitted from the table.
    2. Update the "Expected Behavior" section to describe in more detail what should occur when users run your recipe.
    3. Link to any other resources that a reader might find helpful. No need for detailed explanations of libraries here.
    4. List the npm dependencies your recipe uses (if any).
  7. Regenerate the table of recipes by running make readme while in the root folder
  8. Make sure the code is formatted consistently by running make format
  9. Submit a PR.
    • If this addresses a "Recipe Request" issue, the first line should read Fixes #X where X is the issue number.

Principles

Only use packages in the latest package set release

  • Any PRs that use packages not in the package set will not be merged until all of their packages are in the package set.
    • If you want to use a package that's not in the package set, please add it to the package set.
  • Recipes that use packages that get dropped from the package set will be moved to the broken-recipes folder.

We do not allow anyone to override or add packages in the packages.dhall file for the following reasons:

  • Reduces the burden of maintenance for maintainers of this repo
  • Overriding package A to make Recipe X work now might prevent Recipe Y from working (which doesn't need the override)
  • Somewhat reduces the attack surface of malicious recipes (e.g. including a malicious package via addition/override)

All Recipes are Licensed under This Repo's License (MIT)

All recipes are licensed under MIT. If you want to submit a new recipe but cannot agree to these terms, please open an issue to discuss it further. Unless you have special circumstances that provide a strong enough rationale to change how we should handle recipe licensing, we will not merge your PR.

Link to Learning Resources Rather than Explaining Here Pedagogical

A cookbook demonstrates how to do X. It does not explain why X works, the concepts that X uses to work, or anything else that could bloat a recipe with very long explanations. Rather, it provides links to resources that users can read if they want to learn more.

All Recipes that Use the Same NPM Dependency Must Use the Same Version Across All Recipes

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.

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:

  • in Recipe Z's PR, move Recipes A-Y into the repo's "broken" folder
  • in this repo, open an issue for Recipes A-Y so we know to fix it later

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

Using Make as our build tool

There are three parties whose concerns we wanted to keep in mind:

  1. End users of this library - make it easy to run recipes
  2. Recipe-writers - make it easy to add new recipes
  3. Maintainers of this cookbook - make it easy to test CI and remove broken or outdated recipes

We considered the following build tools:

  • npm scripts: already installed on most end-users' computers but not very flexible or powerful for what we had in mind
  • scriptlauncher: nicer UI than npm scripts but still suffered from the same lack of power
  • make: already installed on most users' computers, powerful, and a bit of a learning curve

make seemed like the best choice between these options. We didn't consider other options for better or worse.

See these sources for help in understanding what the makefile is doing: