OpenFn / OpenFn/kit

Project should always have a Workspace

Open
#1,086 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

  • When we create Project, we can optionally pass in Workspace
  • The Project's config (formerly repo) should directly reference the Workspace config
  • If there is no Workspace, the Project should generate its own config from defaults using the new util/config.ts
  • Aside from the Constructor I don't think the Project needs to know much about the Workspace? But we can keep a pointed
  • Workspace should have a helper function called loadProject. This just called Project.from and sets itself as the Workpace.

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 Project and Workspace implementations, Project.from, and the new util/config.ts. Trace how Project currently receives or stores config and how Workspace loads projects. Done means the constructor, default config behavior, Workspace linkage, and loadProject helper match the issue requirements; no tests are named, so identify the relevant existing test coverage first.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.