OpenFn / OpenFn/docs

Job Writing Best Practices

Open
#772 1 comment 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

  • avoid fn()(state)
  • Iteration
  • Looping
  • Pagination
  • Keeping state small
  • Probably avoid catch

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

Start by locating the job documentation in this repository and reviewing how related guidance is organized. Turn the listed topics into clear best-practice guidance, including examples where the existing documentation supports them, and confirm that each of the listed concerns is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.