OpenFn / OpenFn/docs

Job writing guide: explain more about why you can't do regular js at the top

Open
#605 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

The job writing guide doesn't really explain that regular JS function calls at the top level don't work. You can't do console.log, for example, unless inside an operation.

We might also list what statements you can put at the top (basically variable declarations) and which you can't

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the job writing guide and review how it currently describes top-level JavaScript. Clarify why regular function calls such as console.log do not work there, and list which statements are allowed; the work is done when the guide clearly distinguishes top-level content from operation code.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.